Skip to main content
GET
Retrieve a single persisted parse by ID.

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

parse_id
string
required

Query Parameters

include_output
boolean
default:true

When false, returns a cheap status-only projection (no output), served from cache for in-flight background runs.

Response

Successful Response

A parse result: the per-page and full-document text extracted from a document.

id
string
required

Unique identifier of the parse

file
FileRef · object
required

Information about the parsed file

model
string
required

Model used for parsing

table_parsing_format
enum<string>
required

Format used to render tables extracted from the document

Available options:
markdown,
yaml,
html,
json
output
ParseOutput · object
required

The parsed document content

instructions
string | null

Free-form instructions supplied with the parse request.

status
enum<string>
default:pending

Lifecycle status. The synchronous path returns 'completed'. Background runs progress pending -> queued -> in_progress -> completed | failed | cancelled.

Available options:
pending,
queued,
in_progress,
completed,
failed,
cancelled
error
PrimitiveError · object | null

Error details when a background run fails; null otherwise. Always present so consumers can read it without an existence check.

usage
RetabUsage · object | null

Usage information for the parse operation

created_at
string<date-time> | null