Parse Endpoints

Parse File

Parse files to get cleaned, chunked target content (e.g. markdown). The Parse 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. For more details, see the [Parse File guide](/product/parsing/parse).

Authentication

AuthorizationBearer

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

Headers

x-extend-api-version"2025-04-21"OptionalDefaults to 2025-04-21

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.

Query parameters

responseTypeenumOptional
Controls the format of the response chunks. Defaults to `json` if not specified. * `json` - Returns parsed outputs in the response body * `url` - Return a presigned URL to the parsed content in the response body
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 parsed file
objectenum

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

Allowed values:
idstring

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

Example: "parser_run_xK9mLPqRtN3vS8wF5hB2cQ"

fileIdstring
The identifier of the file that was parsed. This can be used as a parameter to other Extend endpoints, such as processor runs.
chunkslist of objects
An array of chunks that were parsed from the file.
statusenum
The status of the parser run: * `"PROCESSED"` - The file was successfully processed * `"FAILED"` - The processing failed (see failureReason for details)
Allowed values:
metricsobject
Metrics about the parsing process.
configobject
The configuration used for the parsing process, including any default values that were applied.
failureReasonstring or null
The reason for failure if status is "FAILED".
usageobject or null

These are usage credits for parser runs.

This field will not be returned for parser runs created before October 7, 2025, or for customers on legacy billing systems.

For more details on how credits work, see our Credits Guide.

Errors