API referenceJobs and publishing
Get pack
The manual's published pack, its pictures as URLs. The deck as the glasses read it, each picture's `src` a URL: a public link for a public deck, and a signed one for a private deck.
GET
The manual's published pack, its pictures as URLs.
The deck as the glasses read it, each picture's src a URL: a public link for a public deck, and a signed one for a private deck.
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}$The manual's published pack
application/json- response
visibility*stringValue in
"public""private"packKey*stringpackUrl*|Format
uriexpiresAt*|Format
date-timepack*curl -X GET 'https://www.chameleonlabs.org/api/manuals/string/pack'Example Response
{ "visibility": "public", "packKey": "string", "packUrl": "http://example.com", "expiresAt": "2019-08-24T14:15:22Z", "pack": { "format": 6, "manualId": "string", "title": "string", "pictures": { "property1": { "src": "http://example.com", "width": 1, "height": 1 }, "property2": { "src": "http://example.com", "width": 1, "height": 1 } }, "cards": [ { "id": "string", "linkedOnly": true, "fill": { "color": "string", "opacity": 0 }, "elements": [ { "id": "string", "x": -10000, "y": -10000, "width": 1, "height": 1, "rotation": 0, "opacity": 0, "link": "string", "type": "picture", "asset": "string" } ] } ] }}Get job GET
The job running on a manual, or the one that ran last.
Start breakdown POST
Starts a breakdown: every region made into an asset again. Refused at once while the labels fail their checks. The asset index is replaced only when the job ends, so a breakdown that fails leaves the library as it was.