Perception

Get a document job

Other errors (500, 502, 503, 504, 529) are on Errors.

GET
/v1/documents/jobs/{id}

Other errors (500, 502, 503, 504, 529) are on Errors.

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key, sent as Authorization: Bearer nace_sk_...

  • Where: the dashboard's API Keys page. It is shown once, when you create it.
  • Format: nace_sk_ followed by 43 URL-safe characters (A-Z, a-z, 0-9, _ and -).
  • Limit: an account can hold at most 3 active keys.
  • Wrong or missing key: returns 401 authentication_error.

In: header

Path Parameters

idstringrequired

The job's job_id, as returned when it was created.

Formatuuid

Query Parameters

wait_secondsinteger

Hold the read open until the job finishes, up to this many seconds, so a finish is seen when it happens rather than on the next poll. 0 (default) answers at once; a value above 25 waits 25. A job still running when the window closes is returned as it is. A read can also return early with the job still queued or running, for example while a finished job's charge settles. Such a reply takes at least a second, so reading again at once still reads about once a second. An account with many reads held open at once may get a reply without a hold, paced the same way. Set your HTTP timeout to at least 90 seconds.

Range0 <= value

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents/jobs/497f6eca-6276-4993-bfeb-53cbbbba6f08"
{  "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",  "kind": "parse",  "status": "queued",  "result": null,  "credits": 0,  "usage_final": true,  "created_at": "2019-08-24T14:15:22Z",  "started_at": "2019-08-24T14:15:22Z",  "finished_at": "2019-08-24T14:15:22Z",  "timing": {    "received_at": "2019-08-24T14:15:22Z",    "observed_at": "2019-08-24T14:15:22Z",    "completed_at": "2019-08-24T14:15:22Z",    "elapsed_ms": 0,    "total_ms": 0,    "first_response_ms": 0,    "breakdown": {      "preparation_ms": 0,      "queue_ms": 0,      "ndi_processing_ms": 0,      "result_preparation_ms": 0,      "delivery_wait_ms": 0,      "document_finalization_ms": 0    }  },  "cost": {    "pricing_version": "string",    "total_usd": "string",    "lines": [      {        "operation": "parse",        "quantity": 0,        "unit": "page",        "execution": "fresh",        "unit_price_usd": "string",        "amount_usd": "string",        "reuse_reason": "string"      }    ]  }}