Skip to main content
GET
/
api
/
v1
/
marker
/
{request_id}
Marker Result Check
curl --request GET \
  --url https://www.datalab.to/api/v1/marker/{request_id} \
  --header 'X-API-Key: <api-key>'
{
  "status": "<string>",
  "output_format": "<string>",
  "chunks": {},
  "json": {},
  "markdown": "<string>",
  "html": "<string>",
  "extraction_schema_json": "<string>",
  "segmentation_results": {},
  "images": {},
  "metadata": {},
  "rules_metadata": {},
  "success": true,
  "error": "<string>",
  "parse_quality_score": 123,
  "page_count": 123,
  "total_cost": 123,
  "runtime": 123,
  "checkpoint_id": "<string>",
  "versions": {}
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
request_id
string
required

Cookies

​
access_token
string

Response

Successful Response

​
status
string
required

The status of the request. Should be 'complete' when the request is done.

​
output_format
string

The format of the output. 'markdown' or 'json'.

​
chunks

The output in chunks format. The top-level key 'blocks' contains a list of blocks from the document with metadata.

​
json

The JSON representation of the PDF if the output format is 'json'.

​
markdown
string | null

The markdown representation of the PDF if the output format is 'markdown'.

​
html
string | null

The HTML representation of the PDF if the output format is 'html'.

​
extraction_schema_json
string | null

The output of a marker extraction request containing the filled in extraction schema.

​
segmentation_results
object | null

Results of document segmentation showing page ranges for each identified segment. Contains segment names, page ranges, and confidence levels (high/medium/low).

​
images
object | null

A dictionary of the images in the PDF, where the key is the filename for the image, and the value is the base64 encoded image. Images should be stored in the same directory as the PDF.

​
metadata
object | null

A dictionary of metadata about the PDF and the conversion process.

​
rules_metadata
object | null

Metadata describing the output of the rules conversion process.

​
success
boolean | null

Whether the conversion was successful.

​
error
string | null

If the conversion was not successful, this will contain an error message.

​
parse_quality_score
number | null

The parse quality score of the output, if available.

​
page_count
integer | null

The number of pages that were converted.

​
total_cost
integer | null

The total cost of the conversion.

​
runtime
number | null

The runtime of the conversion.

​
checkpoint_id
string | null

The ID of the checkpoint that was created for this conversion. This can be used to retrieve the checkpoint later.

​
versions

A dictionary of the versions of the libraries used in the request.