GET
/
parse
/
jobs
/
{job_id}
/
results
curl --request GET \
  --url https://api.contextual.ai/v1/parse/jobs/{job_id}/results \
  --header 'Authorization: Bearer <token>'
{
  "status": "pending",
  "pages": [
    {
      "index": 123,
      "markdown": "<string>",
      "blocks": [
        {
          "id": "<string>",
          "type": "heading",
          "bounding_box": {
            "x0": 0.5,
            "y0": 0.5,
            "x1": 0.5,
            "y1": 0.5
          },
          "markdown": "<string>",
          "confidence_level": "low"
        }
      ]
    }
  ],
  "markdown_document": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
job_id
string
required

Unique ID of the parse job

Query Parameters

​
output_types
enum<string>[]

The desired output format(s) of the parsed file. Must be markdown-document, markdown-per-page, and/or blocks-per-page. markdown-document parses the whole document into a single concatenated markdown output. markdown-per-page provides markdown output per page. blocks-per-page provides a structured JSON representation of the content blocks on each page, sorted by reading order. Specify multiple values to get multiple formats in the response.

The format of the output to be returned by the /parse endpoint.

Available options:
markdown-document,
markdown-per-page,
blocks-per-page

Response

200
application/json
Successful Response

/parse results reponse object.

​
status
enum<string>
required

The current status of the parse job

Available options:
pending,
processing,
retrying,
completed,
failed,
cancelled
​
pages
object[]

Per-page parse results, containing per-page Markdown (if markdown-per-page was requested) and/or per-page ParsedBlocks (if blocks-per-page was requested).

Per-page parse results.

​
markdown_document
string

The parsed, structured Markdown of the input file. Only present if markdown-document was among the requested output types.

Was this page helpful?