Skip to main content
GET
Get a Parse Job
Returns the job’s status. While it runs, progress says which page it is on ({ "message": "Reading page 3 of 12", "done": 3, "total": 12 }). Once status is completed, the response has the full result, the same shape POST /parse returns. Add ?pages=true to include per-page Markdown.
A failed job has status: "failed" and an error such as "This PDF is password protected. Remove the password and try again.". It isn’t charged.

Authorizations

Authorization
string
header
required

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

Path Parameters

jobId
string
required

Query Parameters

pages
boolean

Include per-page Markdown.

Response

The job, with its result once completed.

jobId
string
status
enum<string>
Available options:
queued,
running,
completed,
failed
fileName
string | null
sourceUrl
string | null
fileId
string | null

Parse the same file again with other options for 24 hours.

format
string | null
totalPages
integer | null
pagesParsed
integer | null
creditsUsed
integer
error
string

Why the document failed. Failed documents aren't charged.

progress
object
markdown
string
pages
object[]

With includePages (or ?pages=true).

json
any

Extracted fields, when prompt or schema was given.

warnings
string[]
metadata
object
durationMs
integer | null