Skip to Content
Chameleon Docs

Preview region

One region finished as a build would finish it, from documents saved nowhere. Send the labels, the image settings or both as an editor holds them; whichever is left out is read as saved. A settings block is laid over the region's own block of those image settings, each setting it names in place of the block's. Nothing is saved and no asset changes. With a backdrop, the answer also holds the picture laid on that color.

POST
/api/manuals/{id}/preview

One region finished as a build would finish it, from documents saved nowhere.

Send the labels, the image settings or both as an editor holds them; whichever is left out is read as saved. A settings block is laid over the region's own block of those image settings, each setting it names in place of the block's. Nothing is saved and no asset changes. With a backdrop, the answer also holds the picture laid on that color.

Authorization

headerx-api-key<token>

Scope: manuals:read

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}$

Request Body

application/json
  1. body
regionId*string
Match^[A-Za-z0-9_-]{1,64}$
labels?
imageSettings?
settings?
backdrop?array<any>

Response Body

The finished picture, the same pixels lossless, and how they were made

application/json
  1. response
requestId*string
Match^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$
regionId*string
picture*
lossless*
viewing?
scale*number
origin*array<any>
resolution*number
measures*
Example Request
curl -X POST 'https://www.chameleonlabs.org/api/manuals/string/preview' \  -H 'Content-Type: application/json' \  -d '{  "regionId": "string"}'
Example Response
{  "requestId": "string",  "regionId": "string",  "picture": {    "url": "http://example.com",    "expiresAt": "2019-08-24T14:15:22Z",    "path": "string",    "width": 0,    "height": 0,    "bytes": 0  },  "lossless": {    "url": "http://example.com",    "expiresAt": "2019-08-24T14:15:22Z",    "path": "string",    "width": 0,    "height": 0,    "bytes": 0  },  "viewing": {    "url": "http://example.com",    "expiresAt": "2019-08-24T14:15:22Z",    "path": "string",    "width": 0,    "height": 0  },  "scale": 0,  "origin": [    -100000,    -100000  ],  "resolution": 0,  "measures": {    "clearShare": 0,    "holeShare": 0,    "smallHoles": 0,    "edgeShare": 0,    "specksDropped": 0  }}