Photo Collect API
Photo Collect ↗
PUTPhotos

Upload to an invitation

Attach photo data to an existing invitation key and run the configured processing pipeline.

PUT/apiv1/photo

Use this direct-upload endpoint when an invitation already exists. Send URL-encoded form data or put the image in the raw request body and move the remaining parameters into the query string.

Request parameters

Parameter Required Description
invitation_key Yes Key returned by POST /invitation.
language_interface No Response language.
pre_edit No Processing already completed by the client, for example bgremoval.
photo_b64 Yes Base64 JPEG, WebP, or PNG when not using raw-body upload.
signature_b64 No Base64 PNG, WebP, JPEG, TIFF, or GIF.

Response

{
  "success": true
}

Invalid images return HTTP 400, for example INVALID_IMAGE with a localized error message.

⌁

Connect your API

Credentials are kept in this session only.