Skip to main content
POST
Parse a document by URL

Authorizations

X-API-KEY
string
header
required

Body

application/json

Input to a parse request.

Server-side limits (page count, file size) are not user-configurable. Unknown fields are accepted and ignored for backward compatibility. The ocr knob is deprecated and currently has no effect.

url
string | null

HTTP(S) URL of the document to parse (URL route only). Input type is detected from the file itself; the extension is a hint.

extract_text
boolean
default:true

Include text chunks in the response. Set false to skip text spans; table chunks (and figures, when extract_images is true) are still returned.

extract_images
boolean
default:true

Include figure (image) chunks in the response. Set false to skip figure extraction; text and table chunks are still returned.

ocr
enum<string>
default:auto

Deprecated. Accepted for backward compatibility but currently has no effect.

Available options:
auto,
never,
force
table_output_format
enum<string>
default:markdown

How table chunks are structured. 'html' puts an HTML table in page_content; 'cell_grid' returns true per-cell bounding boxes. Echoed on each table chunk (falls back to 'markdown' if localization fails).

Available options:
markdown,
cell_grid,
html
chunking
enum<string>
default:none

'none' (default): response unchanged. 'semantic': additionally return segments — elements grouped toward chunk_size characters at semantic/structural boundaries (headings, gaps, page breaks), each segment carrying embed-ready markdown content plus member records with page numbers and bounding boxes.

Available options:
none,
semantic
chunk_size
integer
default:1000

Target segment size in characters of segment content. Segments land in a +/-25% band around this target (default 750-1250). Only meaningful when chunking is enabled; validated (200-8000) only in that case and ignored otherwise.

include_content
boolean
default:false

false (default): response unchanged. true: additionally return content — the entire parsed document as a single text string, concatenated in reading order. Not reformatted as structured markdown; it is the document's own text content end to end.

Response

Successful Response