Parse Endpoints

Parse File Async

Parse files asynchronously to get cleaned, chunked target content (e.g. markdown).

The Parse Async endpoint allows you to convert documents into structured, machine-readable formats with fine-grained control over the parsing process. This endpoint is ideal for extracting cleaned document content to be used as context for downstream processing, e.g. RAG pipelines, custom ingestion pipelines, embeddings classification, etc.

Parse files asynchronously and get a parser run ID that can be used to check status and retrieve results with the Get Parser Run endpoint.

This is useful for:

  • Large files that may take longer to process
  • Avoiding timeout issues with synchronous parsing.

For more details, see the Parse File guide.

Headers

AuthorizationstringRequired

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

x-extend-api-versionenumOptional

API version to use for the request. If you do not specify a version, you will either receive a 400 Bad Request or be set to a previous legacy version. See API Versioning for more details.

Allowed values:

Request

This endpoint expects an object.
fileobjectRequired
A file object containing either a URL or a fileId.
configobjectOptional
Configuration options for the parsing process.

Response

Successfully initiated parser run
objectenum

The type of object. Will always be "parser_run_status".

Allowed values:
idstring

A unique identifier for the parser run. Will always start with "parser_run_"

Example: "parser_run_xK9mLPqRtN3vS8wF5hB2cQ"

statusenum
The status of the parser run.
Allowed values:
failureReasonstring or null
The reason for failure if status is "FAILED".

Errors