Skip to main content
A succeeded parse job has result.result_type: "parse". The payload lives on result.document.

​
Formats

document.markdown, document.text, and document.blocks are present only when you asked for them in output.formats. Default is markdown + blocks. text is a plaintext rendering: headings and images stripped, tables flattened. blocks are layout elements with a Location:

​
Chunks

chunking.strategy:
  • none — chunks is empty
  • page — one page_region chunk per page
  • section — chunks follow section headers
Use chunks for RAG. Use markdown for display.

​
Images

output.include_images=true attaches figure crops on PDF and png / jpg / jpeg / webp uploads. figures.mode=describe captions those blocks. diagrams.mode=mermaid keeps flowchart fences.

​
Spreadsheets

Workbook results may include document.spreadsheet.sheets[].cell_map_url — an authenticated, job-scoped URL that maps rendered table axes to physical rows and columns. Fetch it with the same X-API-Key. See GET /v1/jobs/{job_id}/spreadsheet-cell-maps/{artifact_ref}. Converted-PDF artifacts (Office → PDF) are at GET /v1/jobs/{job_id}/converted-pdf/{artifact_ref}.