Skip to Content
Chameleon Docs
API referenceUploaded pictures

Complete picture upload

Finishes an uploaded picture: upright, without its metadata, as WebP. Call once the file is sent. The picture is finished, and is then placed on cards by its ID as a built picture is. A picture the platform doesn't take is refused with the reason. Called again for a picture already finished, it answers that picture.

POST
/api/manuals/{id}/uploads/{pictureId}/complete

Finishes an uploaded picture: upright, without its metadata, as WebP.

Call once the file is sent. The picture is finished, and is then placed on cards by its ID as a built picture is. A picture the platform doesn't take is refused with the reason. Called again for a picture already finished, it answers that picture.

Authorization

headerx-api-key<token>

Scope: manuals:write

Path Parameters

id*string
Match^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
pictureId*string

Response Body

The finished picture and a link that reads it

application/json
  1. response
picture*
link*
Example Request
curl -X POST 'https://www.chameleonlabs.org/api/manuals/string/uploads/string/complete'
Example Response
{  "picture": {    "id": "string",    "kind": "picture",    "name": "string",    "picture": {      "src": "string",      "hash": "string",      "width": 0,      "height": 0    },    "uploadedAt": "2019-08-24T14:15:22Z"  },  "link": {    "url": "http://example.com",    "expiresAt": "2019-08-24T14:15:22Z"  }}