Skip to main content
GET

Authorizations

Authorization
string
header
required

API key starting with sk_case_

Path Parameters

id
string
required

The OCR job ID returned from the create OCR endpoint

Query Parameters

include_text
enum<string>

Include full OCR text in completed responses (default: false)

Available options:
true,
false

Response

OCR job status and results

id
string
required

OCR job ID

status
enum<string>
required

Current job status

Available options:
pending,
processing,
completed,
failed
created_at
string<date-time>
required

Job creation timestamp

page_count
integer

Number of pages processed

text
string

Extracted text content when completed and include_text=true

metadata
object

Additional processing metadata

completed_at
string<date-time>

Job completion timestamp