PerceptionDocs

List document jobs

The account's own jobs, newest first. Readable at any balance. A job you deleted is not listed.

GET
/v1/documents/jobs

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

Authorization

bearerAuth
AuthorizationBearer <token>

Your API key from the dashboard's API Keys page: nace_sk_ followed by 43 URL-safe characters (A-Z, a-z, 0-9, _ and -), shown once when you create it. Send it as Authorization: Bearer nace_sk_... Any other value returns 401 authentication_error. An account can hold at most 3 active keys.

In: header

Query Parameters

limit?integer
Range1 <= value <= 50
Default20
cursor?string

next_cursor from the previous page.

operation?string

Value in

  • "parse"
  • "split"
  • "classify"
  • "extract"
  • "ground"
status?string

Filters on the job status Drex last recorded; a job that has moved on since is left off the page.

Value in

  • "queued"
  • "running"
  • "succeeded"
  • "failed"
  • "cancelled"

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/v1/documents/jobs"
{  "items": [    {      "job_id": "453bd7d7-5355-4d6d-a38e-d9e7eb218c3f",      "kind": "parse",      "status": "queued",      "result": null,      "credits": 0,      "usage_final": true    }  ],  "next_cursor": "string"}