Skip to main content
Use the API to convert documents into structured Markdown, chunks, and metadata. The API identifies elements like text, tables, and form fields with exact page and coordinate references. After parsing, you can:

Use ADE Parse to Parse Documents

Use the API to parse data from documents. See the full API reference here. To get detailed information about the API response, go to JSON Response for Parsing.

Specify Documents to Parse

The API offers two parameters for specifying the document you want to parse:
  • document: Specify the actual file you want to parse.
  • document_url: Include the URL to the file that you want to parse.

Set Up Splits for Parsing

The split parameter is different from the API. If your goal is to separate a document into sub-documents after parsing, use the API, not the split parameter.
The API includes an optional split parameter that controls how the parsed content is organized in the response. This is how to include the split parameter when calling the API.

Omit the Split Parameter

When you omit the split parameter, the API returns the entire document as a single split. All chunks from all pages are grouped together in one split object with class: "full" and identifier: "full". Omit the split parameter when you need to:
  • Process the entire document as a single unit
  • Maintain document context across pages
  • Extract data that spans multiple pages

Use Page-Level Splits

When you use page-level splits (When you set split=page), the API organizes chunks by page. For multi-page documents, this creates one split per page. Each split has class: "page" and an identifier like page_0, page_1, etc. Use page-level splits (set the split parameter to page) when you need to:
  • Process pages independently
  • Extract data from specific pages
  • Build page-by-page workflows
  • Reduce content size for downstream processing

Add Custom Prompts for Figure Descriptions

Use the optional custom_prompts parameter to customize how describes figures during parsing. For more information, see Custom Prompts for Figure Descriptions.

Example: Parse a Document with the API

This example shows how to parse a document with the API and save the Markdown output to a file. Materials:
The full response will be similar to the JSON below. Notice that each chunk has an id. For example, the first chunk is the text ”# WIRE TRANSFER FORM”. The id for that chunk is 33335548-e7c3-40bd-898e-4f23d6c99d34.
To extract specific fields from the parsed Markdown, see Extract Data.

Run Parse with Our Libraries

Click one of the tiles below to learn how to run the API with our libraries.

Python Library

Run Parse with our Python library.

TypeScript Library

Run Parse with our TypeScript library.