API referenceDocuments
Get document
A manual's labels, image settings or cards, as last saved.
GET
A manual's labels, image settings or cards, as last saved.
header
x-api-key<token>Scope: manuals:read
id*stringMatch
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$name*stringValue in
"labels""image-settings""cards"The document, its version in the ETag
application/json- response
format*4Value in
4manualId*stringMatch
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$template?labelTypes*array<>pageTypes*array<>pages*array<>regions*array<>groups*array<>linkedElements*array<>order?array<>curl -X GET 'https://www.chameleonlabs.org/api/manuals/string/documents/labels'Example Response
{ "format": 4, "manualId": "string", "template": { "templateId": "string", "name": "string" }, "labelTypes": [ { "id": "string", "name": "string", "color": [ 0, 0, 0 ] } ], "pageTypes": [ { "id": "string", "name": "string" } ], "pages": [ { "page": 1, "size": [ 100000, 100000 ], "type": "string" } ], "regions": [ { "id": "string", "page": 1, "polygon": [ [ -100000, -100000 ], [ -100000, -100000 ], [ -100000, -100000 ] ], "labelType": "string", "name": "string", "count": 1, "link": "string", "area": true, "text": true, "content": "string" } ], "groups": [ { "id": "string", "name": "string", "count": 1, "members": [ "string" ] } ], "linkedElements": [ { "id": "string", "name": "string", "count": 1 } ], "order": [ "string" ]}Get source PDF link GET
A link that reads the manual's inspected PDF, for an hour.
Replace document PUT
Writes a document whole, over the version last read. The body is checked against the document's format and stored in its standard form. Send If-Match with the ETag last read; a document changed since answers 412. Cards don't exist until first written: send If-None-Match: * for that write. A document an agent writes changes only what agents change in the saved one: any other part changed answers 422, an issue for each.