API referenceReads
Read region
A saved region as the PDF renders it, unfinished, with the PDF's text inside it.
POST
A saved region as the PDF renders it, unfinished, with the PDF's text inside it.
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}$regionId*stringMatch
^[A-Za-z0-9_-]{1,64}$application/json- body
pixelsPerPoint?numberRange
0 < value <= 100The picture's link and size, and the text
application/json- response
requestId*stringMatch
^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$page*integerpicture*scale*numberorigin*array<any>words*array<>text*stringregionId*stringcurl -X POST 'https://www.chameleonlabs.org/api/manuals/string/regions/string/read' \ -H 'Content-Type: application/json' \ -d '{}'Example Response
{ "requestId": "string", "page": 0, "picture": { "url": "http://example.com", "expiresAt": "2019-08-24T14:15:22Z", "path": "string", "width": 0, "height": 0 }, "scale": 0, "origin": [ -100000, -100000 ], "words": [ { "text": "string", "box": [ 0, 0, 0, 0 ] } ], "text": "string", "regionId": "string"}Read page sheet POST
Pages side by side in one picture, each captioned with its number. For finding pages, not for measuring on them: each page is drawn as large as its own cell lets it be, so no one scale maps the picture onto a page. The picture is drawn larger than a single read.
Get job GET
The job running on a manual, or the one that ran last.