Elements API

The Elements API allows you to get the elements extracted from documents. For example, if you upload a PDF with a lot of Tables, you might want to get the content just for those - skipping the headers, images, and so on.


📘

Some of the elements are only available in agentic mode - currently in beta. Want to try it out? Contact us at [email protected]

Structure

An Element looks like this

{
      "id": "9d0799a2-d891-4c4f-ba84-e507b631023d",
      "created_at": "2026-02-14T00:41:50.150050Z",
      "index": 6,
      "metadata": {
        "languages": [
          "eng"
        ],
        "filetype": "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
      },
      "type": "Table",
      "text": "<table>\n <thead>\n  <tr>\n   <th>\n    animal...",
      "markdown": "\n\n| animal | behavior | friendliness | utility |...",
      "location": null,
      "data": {
        "type": "Table",
        "content": "<table>....",
        "description": "The table consists of information about different animals and their characteristics...",
        "header_range": null
      }
    }

Here are the general properties, see Element Types & Data Content for more details

PropertyDescriptionType
idunique id of the elementstring
created_atwhen the element was createdstring
indexThe relative location of the element in the document when viewed top to bottom. A smaller number means earlier, 0 being the first.number
metadataAdditional information about the element
typeThe element type
textTextual representation of the element
markdownThe markdown representation of the element, if appropriate.
locationWhere in the document the element was found. This is context sensitive.
data_contentElement specific data

Location

This helps identify where an element is location relative to the document.


Bounding box

Locations in PDFs are bounding boxes of where the element was found in the page.

{
	"location_type": "bounding_box",
	"left": 0.0965,
	"top": 0.048,
	"width": 0.154,
	"height": 0.0339,
	"page_number": 1
}

Left, top, width, and height are all Normalized values. So 0 for left means the left-most, and 1 means the right most part of the page.

Character index

Inside a markdown file, locations are indicated by character ranges.

{
	"location_type": "character_index",
	"start_char_index": 23,
	"end_char_index": 1037
}

Spreadsheet

Locations inside a spreadsheet tell you what cell or cell range elements were found in.

{
	"location_type": "spreadsheet",
	"range": "B3:B3",
	"sheet_name": "Sheet1",
	"sheet_index": 0
}

Duration

Inside audio and video segments, you find duration locations. These tell you where in the file the content was found.

{
	"location_type": "duration",
	"start_time": 0,
	"end_time": 9.96,
	"duration": 9.96
}

Document Elements

The following element types may appear when parsing a document.

📘

Some element types are specialized and only appear for certain types. For example, AudioTranscriptionSegment and VideoSegment are audio/video-specific and are not detected in PDFs.

Element TypeDescriptionTypical ContentSupported Mode
AddressPostal address text.Mailing addressfast, hi_res, agentic_ocr
AudioTranscriptionSegmentSegment of transcribed audio.Segment text and per-word timingaudio/video
AuthorAuthor name or byline.Person or organization nameagentic_ocr
BarcodeBarcode and any nearby associated text.Barcode-associated textagentic_ocr
BibliographyBibliography or references section.Citation listagentic_ocr
ButtonButton-like UI element.Button labelagentic_ocr
CalendarDateDate text.Date stringagentic_ocr
CaptionGeneric caption from unstructured extraction.Caption textagentic_ocr
CodeCode block or code snippet.Code content and languagefast, hi_res, agentic_ocr
CommentComment or annotation text.Comment textagentic_ocr
DefinitionListDefinition-style list.Markdown definitionsagentic_ocr
EmailAddressEmail address text.Email valuefast, hi_res, agentic_ocr
FigureCharts, screenshots, diagrams, photos, or visuals.OCR text and visual descriptionagentic_ocr
FigureCaptionCaption associated with a figure.Figure caption textfast, hi_res, agentic_ocr
FooterFooter content, near the bottom of a pageDisclaimers, company addresses, version numbershi_res, agentic_ocr
FootnoteFootnote content, typically near the bottom of a page.Footnote textfast, agentic_ocr
FormFieldInteractive form field.Label, value, options, input typeagentic_ocr
FormulaMathematical expression.Plain text formula and optional LaTeXfast, hi_res, agentic_ocr
HeaderRecurring page-level content at the top margin.Page numberfast, hi_res, agentic_ocr
ImageUnstructured image element.OCR text and visual descriptionfast, hi_res
JsonJSON content.JSON textfast, hi_res, agentic_ocr
KeyValueStatic labeled attribute/value pair.Key and valueagentic_ocr
ListItemSingle list item from extraction.One bullet or numbered itemfast, hi_res
LogoCompany or entity logo.OCR text and logo descriptionagentic_ocr
NarrativeTextNarrative prose from extraction.Paragraph textfast, hi_res
OrderedListNumbered list.Markdown list with numbersagentic_ocr
PageBreakExplicit page break marker.No contentfast, hi_res
QrCodeQR code value.Encoded valueagentic_ocr
QuoteQuoted text.Quotation contentagentic_ocr
SectionHeaderStructural heading within the body of the document.Section titleagentic_ocr
SignatureSignature area, signed or unsigned.Signature text, signer metadataagentic_ocr
StampInk stamp, seal, or official mark.Stamp text and descriptionagentic_ocr
SubHeaderSub-heading within a section.Short heading textagentic_ocr
TableTabular content.HTML, markdown of table plus summaryfast, hi_res, agentic_ocr
TableCaptionCaption associated with a table.Table caption textagentic_ocr
TableOfContentsTable of contents section.Section listing with page numbersagentic_ocr
TextGeneral body text.Paragraph textagentic_ocr
TimeTime text.Time stringagentic_ocr
TitleMain document title. Usually prominent and near the start of the document.Title textfast, hi_res, agentic_ocr
UncategorizedTextText that could not be classified more specifically.Raw textfast, hi_res
UnorderedListBulleted list.Markdown list with bulletsagentic_ocr
VideoVideo or embedded video placeholder.A description of the video visualagentic_ocr
VideoSegmentSegment of video content.Segment text and per-word timingaudio/video
WatermarkWatermark overlay on the page.Watermark textagentic_ocr

Element Types

These element-specific fields go into the data key of the response.

Address

Represents a postal address.

FieldTypeDescription
type"Address"Element type
contentstringAddress text

Example

{
  "type": "Address",
  "content": "123 Main Street\nSpokane Valley, WA 99206"
}

AudioTranscriptionSegment

Represents a segment of transcribed audio with per-word timing metadata.

FieldTypeDescription
type"AudioTranscriptionSegment"Element type
contentstring or nullSegment text
modality_dataarrayPer-word timing and probability data

Example

{
  "type": "AudioTranscriptionSegment",
  "content": "Welcome to the quarterly review.",
  "modality_data": [
    { "word": "Welcome", "probability": 0.99, "start": 0.0, "end": 0.42 },
    { "word": "to", "probability": 0.98, "start": 0.43, "end": 0.50 },
    { "word": "the", "probability": 0.99, "start": 0.51, "end": 0.58 },
    { "word": "quarterly", "probability": 0.97, "start": 0.59, "end": 1.10 },
    { "word": "review.", "probability": 0.98, "start": 1.11, "end": 1.55 }
  ]
}

Author

Represents an author or byline.

FieldTypeDescription
type"Author"Element type
contentstringAuthor name

Example

{
  "type": "Author",
  "content": "Jane Smith"
}

Barcode

Represents a barcode and nearby associated text.

FieldTypeDescription
type"Barcode"Element type
contentstringNearby associated text

Example

{
  "type": "Barcode",
  "content": "Tracking ID: 1Z999AA10123456784"
}

Bibliography

Represents bibliography or references content.

FieldTypeDescription
type"Bibliography"Element type
contentstringMarkdown-formatted bibliography text

Example

{
  "type": "Bibliography",
  "content": "1. Smith, J. *Security Systems*. 2025.\n2. Doe, A. *Infrastructure at Scale*. 2024."
}

Button

Represents a button-like user interface element.

FieldTypeDescription
type"Button"Element type
contentstringButton label

Example

{
  "type": "Button",
  "content": "Submit"
}

CalendarDate

Represents a date string extracted from the document.

FieldTypeDescription
type"CalendarDate"Element type
contentstringDate text as it appears

Example

{
  "type": "CalendarDate",
  "content": "March 1, 2026"
}

Caption

FieldTypeDescription
type"Caption"Element type
contentstringCaption text

Example

{
  "type": "Caption",
  "content": "Figure 2. Quarterly revenue by region."
}

Code

Represents a code snippet or code block.

FieldTypeDescription
type"Code"Element type
contentstringCode content
languagestringDetected or assigned language

Example

{
  "type": "Code",
  "content": "def hello():\n    return \"world\"",
  "language": "python"
}

Comment

Represents comment or annotation text.

FieldTypeDescription
type"Comment"Element type
contentstringComment content

Example

{
  "type": "Comment",
  "content": "Reviewer note: verify the totals against the signed copy."
}

DefinitionList

Represents a definition-style list.

FieldTypeDescription
type"DefinitionList"Element type
contentstringMarkdown-formatted definition list

Example

{
  "type": "DefinitionList",
  "content": "Parse\n: Extract structured document elements\n\nIndex\n: Create retrievable chunks and embeddings"
}

EmailAddress

Represents an email address.

FieldTypeDescription
type"EmailAddress"Element type
contentstringEmail address

Example

{
  "type": "EmailAddress",
  "content": "[email protected]"
}

Figure

Represents a chart, screenshot, photograph, or other visual. It includes OCR text and a descriptive interpretation of the image.

FieldTypeDescription
type"Figure"Element type
contentstringOCR text visible in the figure
descriptionstringDescription of what the figure depicts
base64_datastring or nullOptional post-processing image payload

Example

{
  "type": "Figure",
  "content": "Revenue by Quarter\nQ1 Q2 Q3 Q4",
  "description": "A bar chart comparing quarterly revenue, with steady growth from Q1 through Q4.",
  "base64_data": null
}

Footnote

Represents footnote content.

FieldTypeDescription
type"Footnote"Element type
contentstringFootnote text

Example

{
  "type": "Footnote",
  "content": "1. Includes adjusted figures for the prior reporting period."
}

FormField

Represents an interactive form field, including text inputs, checkboxes, grouped choices, date fields, and similar controls.

FieldTypeDescription
type"FormField"Element type
input_typestringInput type such as text, checkbox, radio-group, or date
contentstringASCII representation of the field including label and value
labelstringPrimary field label
valuestring or nullFilled value for simple fields
optionsarray or nullAvailable options for grouped controls
selected_valuesarray or nullSelected labels for grouped controls
help_textstring or nullOptional help text

Example: text field

{
  "type": "FormField",
  "input_type": "text",
  "content": "Name: Jane Smith",
  "label": "Name",
  "value": "Jane Smith",
  "options": null,
  "selected_values": null,
  "help_text": null
}

Example: checkbox group

{
  "type": "FormField",
  "input_type": "checkbox-group",
  "content": "Preferred Contact: [x] Email [ ] Phone [x] SMS",
  "label": "Preferred Contact",
  "value": null,
  "options": [
    { "label": "Email" },
    { "label": "Phone" },
    { "label": "SMS" }
  ],
  "selected_values": ["Email", "SMS"],
  "help_text": "Select all that apply."
}

Formula

Represents a mathematical expression.

FieldTypeDescription
type"Formula"Element type
contentstringPlain-text visual form of the formula
latexstring or nullLaTeX form without delimiters

Example

{
  "type": "Formula",
  "content": "x = (-b ± √(b² - 4ac)) / 2a",
  "latex": "x = \\frac{-b \\pm \\sqrt{b^2 - 4ac}}{2a}"
}

Header

Represents recurring top-of-page metadata such as page numbers or dates.

FieldTypeDescription
type"Header"Element type
contentstringHeader text

Example

{
  "type": "Header",
  "content": "Confidential • Page 2"
}

Image

FieldTypeDescription
type"Image"Element type
contentstringOCR text visible in the image
descriptionstringDescription of the image

Example

{
  "type": "Image",
  "content": "Warning\nHigh Voltage",
  "description": "A safety sign with a yellow triangle and a black lightning bolt symbol."
}

Json

Represents JSON text extracted as its own semantic element.

FieldTypeDescription
type"Json"Element type
contentstringJSON text

Example

{
  "type": "Json",
  "content": "{\"status\": \"ok\", \"count\": 3}"
}

KeyValue

Represents a static labeled key/value pair.

FieldTypeDescription
type"KeyValue"Element type
keystringAttribute label
valuestringValue text

Example

{
  "type": "KeyValue",
  "key": "Invoice #",
  "value": "INV-10482"
}

Logo

Represents a company or organization logo.

FieldTypeDescription
type"Logo"Element type
contentstringOCR text visible in the logo
descriptionstringDescription of the logo
base64_datastring or nullOptional post-processing image payload

Example

{
  "type": "Logo",
  "content": "Ragie",
  "description": "A simple wordmark logo with the company name in bold sans-serif type.",
  "base64_data": null
}

NarrativeText

FieldTypeDescription
type"NarrativeText"Element type
contentstringNarrative text

Example

{
  "type": "NarrativeText",
  "content": "The project entered a new phase following the completion of the migration."
}

OrderedList

Represents a numbered list. The extracted content is formatted in markdown and includes numbering.

FieldTypeDescription
type"OrderedList"Element type
contentstringMarkdown-formatted numbered list

Example

{
  "type": "OrderedList",
  "content": "1. Open the dashboard\n2. Select the document\n3. Click Reprocess"
}

PageBreak

FieldTypeDescription
type"PageBreak"Element type

Example

{
  "type": "PageBreak"
}

***## QrCode

Represents the value encoded by a QR code.

FieldTypeDescription
type"QrCode"Element type
contentstringEncoded QR code value

Example

{
  "type": "QrCode",
  "content": "https://example.com/verify?id=abc123"
}

Quote

Represents quoted text.

FieldTypeDescription
type"Quote"Element type
contentstringQuoted text

Example

{
  "type": "Quote",
  "content": "Security is not a product, but a process."
}

SectionHeader

Represents a section heading within the main body of the document.

FieldTypeDescription
type"SectionHeader"Element type
contentstringSection heading text

Example

{
  "type": "SectionHeader",
  "content": "3. Risk Factors"
}

Signature

Represents a signature field or signature area, whether signed or unsigned.

FieldTypeDescription
type"Signature"Element type
contentstringBest-effort textual representation of the signature area
descriptionstringDescription of the signature region
labelstringPrinted signature label
is_signedbooleanWhether a signature is present
signer_namestring or nullSigner name if legible
datestring or nullSignature date if present

Example

{
  "type": "Signature",
  "content": "Authorized By: Jane Smith\nSigned\n03/01/2026",
  "description": "A signature line containing a handwritten signature and a handwritten date.",
  "label": "Authorized By",
  "is_signed": true,
  "signer_name": "Jane Smith",
  "date": "03/01/2026"
}

Stamp

Represents an official stamp, seal, or ink mark.

FieldTypeDescription
type"Stamp"Element type
contentstringText visible in the stamp
descriptionstringDescription of the stamp

Example

{
  "type": "Stamp",
  "content": "PAID",
  "description": "A rectangular red ink stamp with the word PAID centered inside."
}

SubHeader

Represents a subordinate heading within a section.

FieldTypeDescription
type"SubHeader"Element type
contentstringSub-header text

Example

{
  "type": "SubHeader",
  "content": "Regional Performance"
}

Table

Represents tabular content. Table content is returned as valid HTML for the table structure.

FieldTypeDescription
type"Table"Element type
contentstringHTML <table> representation
descriptionstringBrief summary of what the table shows
header_rangestring or nullOptional normalized header range

Example

{
  "type": "Table",
  "content": "<table><thead><tr><th>Quarter</th><th>Revenue</th></tr></thead><tbody><tr><td>Q1</td><td>$2.1M</td></tr><tr><td>Q2</td><td>$2.5M</td></tr></tbody></table>",
  "description": "A two-column revenue table showing quarterly revenue for Q1 and Q2.",
  "header_range": "0-0"
}

TableOfContents

Represents a table of contents.

FieldTypeDescription
type"TableOfContents"Element type
contentstringMarkdown-formatted table of contents

Example

{
  "type": "TableOfContents",
  "content": "1. Introduction ........ 1\n2. Findings ............ 4\n3. Appendix ............ 12"
}

Text

Represents general body text that is not better classified as a more specific text type.

FieldTypeDescription
type"Text"Element type
contentstringExtracted text
handwrittenbooleanWhether the text appears handwritten

Example

{
  "type": "Text",
  "content": "Payment is due within 30 calendar days of receipt.",
  "handwritten": false
}

Time

Represents a time string extracted from the document.

FieldTypeDescription
type"Time"Element type
contentstringTime text as it appears

Example

{
  "type": "Time",
  "content": "2:30 PM"
}

Title

Represents the main title of the document.

FieldTypeDescription
type"Title"Element type
contentstringTitle text

Example

{
  "type": "Title",
  "content": "2025 Annual Security Review"
}

UncategorizedText

FieldTypeDescription
type"UncategorizedText"Element type
contentstringText that could not be classified more specifically

Example

{
  "type": "UncategorizedText",
  "content": "Reference block A-17"
}

UnorderedList

Represents a bulleted list. The extracted content is formatted in markdown and includes bullet markers.

FieldTypeDescription
type"UnorderedList"Element type
contentstringMarkdown-formatted list content

Example

{
  "type": "UnorderedList",
  "content": "- Review logs\n- Rotate credentials\n- Re-run validation"
}

Video

Represents a video or a video placeholder.

FieldTypeDescription
type"Video"Element type
contentstringDescription of the video or placeholder

Example

{
  "type": "Video",
  "content": "Embedded training video thumbnail with a play button overlay."
}

Media-Specific Elements

These element types are used in audio and video workflows rather than PDF parsing.

VideoSegment

Represents a segment in video workflows.

FieldTypeDescription
type"VideoSegment"Element type
contentstring or nullSegment content

Example

{
  "type": "VideoSegment",
  "content": "Slide changes from agenda to architecture overview."
}

Watermark

Represents watermark text overlaid on the page.

FieldTypeDescription
type"Watermark"Element type
contentstringWatermark text

Example

{
  "type": "Watermark",
  "content": "DRAFT"
}