Get a job¶
GET /document-intelligence/v1/jobs/{job_id}
How is the work going that a 202 accepted?
A failed job is not a failed request. 202 from an ingestion call means we took the work on; whether the documents actually processed is answered here, per document. This is the step integrations most often skip.
Parameters¶
| Name | In | Required | Notes |
|---|---|---|---|
job_id |
path | yes | - |
Example¶
curl -X GET "https://api.futuresmart.ai/document-intelligence/v1/jobs/{job_id}" \
-H "Authorization: Bearer $FS_API_KEY"
Responses¶
200
| Field | Type | Required | Notes |
|---|---|---|---|
job_id |
string | yes | - |
collection_id |
string | yes | - |
kind |
string | yes | - |
status |
string | yes | - |
document_count |
integer | yes | - |
succeeded_count |
integer | yes | - |
failed_count |
integer | yes | - |
documents |
array of JobDocument | yes | - |
Every failure, a malformed request included, comes back in the shared envelope with a stable code to branch on. See Errors.