Parsing
Overview
Document parsing extracts structured content from PDFs and other documents, preserving layout information and enabling intelligent content processing.
Learn more about document parsing in our complete guide including supported formats, element types, and processing modes.
Create Parsing Job
POST/v1/parsing/jobs
Starts a new document parsing job to extract structured content from an uploaded file. Processing is asynchronous.
Authorization
- Authorization
Authorization- Type
- string
- Required or Optional
- required
Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`
Request Body
- file_id
file_id- Type
- string
- Required or Optional
- required
The identifier of the uploaded file to be parsed.- element_types
element_types- Type
- enum
- Required or Optional
- optional
An array specifying the types of document elements to extract.Options:captionfootnoteformulalist-itempage-footerpage-headerpicturesection-headertabletexttitle- chunking_strategy
chunking_strategy- Type
- enum
- Required or Optional
- optional
The strategy used to divide the document into chunks.Options:page- return_format
return_format- Type
- enum
- Required or Optional
- optional
The desired output format for the extracted content.Options:htmlmarkdownplain- mode
mode- Type
- enum
- Required or Optional
- optional
- Default
- default:
high_quality
The processing mode for OCR and content extraction.Options:fasthigh_quality
Response Body
- id
id- Type
- string
- Required or Optional
- required
The unique identifier for the parsing job.- file_id
file_id- Type
- string
- Required or Optional
- required
The identifier of the file being parsed.- status
status- Type
- string
- Required or Optional
- required
The current processing status of the job.Constraints:Initial status: pending- error
error- Type
- object
- Required or Optional
- optional
An object containing details about an error if one occurred.- result
result- Type
- object
- Required or Optional
- optional
An object containing the results of the completed job.- started_at
started_at- Type
- string
- Required or Optional
- optional
The timestamp indicating when processing started.- finished_at
finished_at- Type
- string
- Required or Optional
- optional
The timestamp indicating when processing finished.- created_at
created_at- Type
- string
- Required or Optional
- required
The timestamp indicating when the job was created.- updated_at
updated_at- Type
- string
- Required or Optional
- optional
The timestamp indicating when the job was last updated.- object
object- Type
- string
- Required or Optional
- required
The type of this object.
Retrieve Parsing Job
GET/v1/parsing/jobs/{job_id}
Retrieves the current status and results of a parsing job. Use this to check progress and get extracted content.
Authorization
- Authorization
Authorization- Type
- string
- Required or Optional
- required
Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`
Path Parameter
- job_id
job_id- Type
- string
- Required or Optional
- required
The unique identifier of the target parsing job.
Response Body
- id
id- Type
- string
- Required or Optional
- required
The unique identifier for the parsing job.- file_id
file_id- Type
- string
- Required or Optional
- required
The identifier of the file being parsed.- status
status- Type
- string
- Required or Optional
- required
The current processing status of the job.- error
error- Type
- object
- Required or Optional
- optional
An object containing details about an error if one occurred.- result
result- Type
- object
- Required or Optional
- optional
An object containing the results of the completed job.- started_at
started_at- Type
- string
- Required or Optional
- optional
The timestamp indicating when processing started.- finished_at
finished_at- Type
- string
- Required or Optional
- optional
The timestamp indicating when processing finished.- created_at
created_at- Type
- string
- Required or Optional
- required
The timestamp indicating when the job was created.- updated_at
updated_at- Type
- string
- Required or Optional
- optional
The timestamp indicating when the job was last updated.- object
object- Type
- string
- Required or Optional
- required
The type of this object.
List Parsing Jobs
GET/v1/parsing/jobs
Retrieves a paginated list of all parsing jobs in your account with their current status.
Authorization
- Authorization
Authorization- Type
- string
- Required or Optional
- required
Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`
Query Parameters
- limit
limit- Type
- integer
- Required or Optional
- optional
The maximum number of items to return in the list.- offset
offset- Type
- integer
- Required or Optional
- optional
The number of items to skip before starting the list.
Response Body
- object
object- Type
- string
- Required or Optional
- required
The type of the response object.- data
data- Type
- JobListResponse[]
- Required or Optional
- required
A list containing the parsing job objects.- pagination
pagination- Type
- object
- Required or Optional
- required
An object containing pagination details for the list.
Delete Parsing Job
DELETE/v1/parsing/jobs/{job_id}
Permanently deletes a parsing job and its results. This action cannot be undone.
Authorization
- Authorization
Authorization- Type
- string
- Required or Optional
- required
Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`
Path Parameter
- job_id
job_id- Type
- string
- Required or Optional
- required
The unique identifier of the target parsing job.
Response Body
- id
id- Type
- string
- Required or Optional
- required
The ID of the deleted job.- deleted
deleted- Type
- boolean
- Required or Optional
- required
A boolean indicating whether the deletion was successful.- object
object- Type
- string
- Required or Optional
- required
The type of this object.
Cancel Parsing Job
PATCH/v1/parsing/jobs/{job_id}
Cancels a parsing job that is currently in progress. Jobs that have already completed cannot be cancelled.
Authorization
- Authorization
Authorization- Type
- string
- Required or Optional
- required
Bearer token for API authentication. Format: `Bearer YOUR_API_KEY`
Path Parameter
- job_id
job_id- Type
- string
- Required or Optional
- required
The unique identifier of the target parsing job.
Response Body
- id
id- Type
- string
- Required or Optional
- required
The unique identifier for the parsing job.- file_id
file_id- Type
- string
- Required or Optional
- required
The identifier of the file being parsed.- status
status- Type
- string
- Required or Optional
- required
The current processing status of the job.Constraints:Should be 'cancelled' if successful- error
error- Type
- object
- Required or Optional
- optional
An object containing details about an error if one occurred.- result
result- Type
- object
- Required or Optional
- optional
An object containing the results if the job completed before cancellation.- started_at
started_at- Type
- string
- Required or Optional
- optional
The timestamp indicating when processing started.- finished_at
finished_at- Type
- string
- Required or Optional
- optional
The timestamp indicating when processing finished.- created_at
created_at- Type
- string
- Required or Optional
- required
The timestamp indicating when the job was created.- updated_at
updated_at- Type
- string
- Required or Optional
- optional
The timestamp indicating when the job was last updated.- object
object- Type
- string
- Required or Optional
- required
The type of this object.
Files
API reference for managing files in Mixedbread. This documentation covers all essential endpoints to get you started with file management.
Reranking
API reference for Mixedbread's Reranking endpoint. This documentation covers all essential endpoints to get you started with reranking.
Last updated: June 11, 2025