Skip to main content
GET
/
v1
/
jobs
List extraction jobs
curl --request GET \
  --url http://localhost:8000/v1/jobs \
  --header 'Authorization: Bearer <token>'
{
  "jobs": [
    {
      "job_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "status": "pending",
      "created_at": "2023-11-07T05:31:56Z",
      "processing_completed_at": "2023-11-07T05:31:56Z",
      "processing_time_seconds": 123
    }
  ],
  "total": 123,
  "page": 123,
  "per_page": 123
}

Authorizations

​
Authorization
string
header
required

API Key authentication. Format: dk_test_ or dk_live_

Query Parameters

​
status
enum<string> | null

Filter by job status

Available options:
pending,
processing,
completed,
failed
​
document_id
string<uuid> | null

Filter by document ID

​
page
integer
default:1

Page number (1-indexed)

Required range: x >= 1
​
per_page
integer
default:20

Items per page (max 100)

Required range: 1 <= x <= 100

Response

Paginated list of extraction jobs

Response for listing jobs (GET /v1/jobs).

​
jobs
JobListItem · object[]
required

List of extraction jobs

​
total
integer
required

Total number of jobs matching the query

​
page
integer
required

Current page number (1-indexed)

​
per_page
integer
required

Number of items per page