Chapter processing status
GET
The running or the last finished processing of the chapter (also one started on the website). Poll every few seconds until status is DONE or FAILED. Free.
apiKeyheader
AuthorizationBearer <nlk_… (team API key)>id*stringFormat
uuidThe processing.
application/json- response
Processing of a chapter.
id?stringFormat
uuidchapterId?stringFormat
uuidrequestId?|The request that started the processing; its cost — GET /ext/v1/requests/{requestId}. null — started on the website.
Format
uuidstatus?stringDONE may still have items with ERROR, BUSY or PAYMENT_REQUIRED — check items.
Value in
"RUNNING""DONE""FAILED"wave?integerCurrent stage: -1 — queued (starts within seconds), 0 — assemble, 1 — OCR; higher — steps started on the website.
Format
int32failure?|FAILED only: PAYMENT_REQUIRED — balance or key limit ran out on the way; ASSEMBLE_FAILED — pages could not be built.
Value in
"PAYMENT_REQUIRED""ASSEMBLE_FAILED"items?array<>One line per step × page. FINISHED means the operation ended; whether text was found is in the chapter's ocrDone.
createdAt?stringFormat
date-timeupdatedAt?stringFormat
date-timefinishedAt?|Format
date-timecurl -X GET 'https://api.neurolate.com/ext/v1/chapters/497f6eca-6276-4993-bfeb-53cbbbba6f08/pipeline'Example Response
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"chapterId": "2a48aff7-27e7-4ab6-9471-1ee9c5632811",
"requestId": "d385ab22-0f51-4b97-9ecd-b8ff3fd4fcb6",
"status": "RUNNING",
"wave": 0,
"failure": "PAYMENT_REQUIRED",
"items": [
{
"step": "ASSEMBLE",
"pageId": "347b9bf8-fe00-46f6-b8ca-1e06b3bd5809",
"status": "DISPATCHED"
}
],
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"finishedAt": "2019-08-24T14:15:22Z"
}