Skip to main content
GET
/
api
/
v1
/
jobs
/
{jobId}
cURL
curl https://app.okrapdf.com/api/v1/jobs/ocr-abc123 \
  -H "Authorization: Bearer okra_YOUR_KEY"
{
  "job_id": "<string>",
  "status": "queued",
  "filename": "<string>",
  "total_pages": 123,
  "pages_completed": 123,
  "pages_failed": 123,
  "progress_percent": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "error": "<string>",
  "results_url": "<string>",
  "viewer_url": "<string>"
}

Authorizations

​
Authorization
string
header
required

API key as Bearer token: Authorization: Bearer okra_xxx

Path Parameters

​
jobId
string
required

The job ID returned from the extract endpoint

Response

Job details

​
job_id
string
required
​
status
enum<string>
required
Available options:
queued,
processing,
completed,
failed
​
filename
string | null
​
total_pages
integer | null
​
pages_completed
integer
​
pages_failed
integer
​
progress_percent
integer | null

0-100

​
created_at
string<date-time>
​
updated_at
string<date-time>
​
error
string | null
​
results_url
string

Present only when status is completed

​
viewer_url
string

URL to view the document in the OkraPDF web viewer