v1

latestOpenAPI 3.1.02026-07-26151126273.9 KB

Convert Result Check

Poll this endpoint to check the status of a Convert request and retrieve the converted document.

get/api/v1/convert/{request_id}

Path parameters

request_idstring required

Cookies

wos-sessionstring

datalab_active_teamstring

Response

Successful Response

statusstring required

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

result_urlstring nullable

Signed URL for downloading the completed result JSON when direct result download is required.

expires_ininteger nullable

Number of seconds until result_url expires.

output_formatstring

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

markdownstring nullable

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

htmlstring nullable

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

extraction_schema_jsonstring nullable

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

extraction_score_averagenumber nullable

Average confidence score (1-5) across all extracted fields, when scoring is applied.

extraction_modestring nullable

The extraction mode used for this request: 'turbo', 'fast', or 'balanced'.

segmentation_resultsobject nullable

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

segmentation_schemastring nullable

The segmentation schema that was applied to this request, echoed back for reference.

imagesobject nullable

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.

metadataobject nullable

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

successboolean nullable

Whether the conversion was successful.

errorstring nullable

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

parse_quality_scorenumber nullable

The parse quality score of the output, if available.

page_countinteger nullable

The number of pages that were converted.

total_costinteger nullable

The total cost of the conversion.

cost_breakdownobject nullable

A dictionary of the cost breakdown of this request. Includes the list cost without discounts and final cost to clients after any discounts (e.g. for opting into model training).

runtimenumber nullable

The runtime of the conversion.

checkpoint_idstring nullable

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