Skip to navigation

Upload Request Picture

View as Markdown

Uploads a picture for a request and returns its id. Send the id in photos, or in a PHOTO answer’s files, on Create Request within 24 hours; pictures not used by then are removed. Each picture can be used once. The body can be up to 15 MB on this endpoint.

Keys: public key or secret key.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

identitystring
The identity for the active workspace.

Headers

channelstringRequired
client-ipstringOptional
The shopper's IP address. Read only when the request is signed with a secret key, so a server calling on behalf of many shoppers does not share one rate limit. Ignored for public keys.

Request

This endpoint expects an object.
filestringRequired

The picture as a data URI, such as data:image/jpeg;base64,.... PNG, JPG, GIF, WEBP or AVIF, at most 10 MB before encoding.

Response

Successfully uploaded picture
statusboolean

Always true on success.

messagestring

Human-readable outcome.

dataobject

Errors

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error