--- title: "List Elements For Document" method: GET path: "/documents/{document_id}/elements" tags: ["elements"] --- # List Elements For Document `GET /documents/{document_id}/elements` List the latest elements for a document. The results are sorted by index in ascending order. Results are paginated with a max limit of 100. When more elements are available, a `cursor` will be provided. Use the `cursor` parameter to retrieve the subsequent page ## Path parameters - `document_id` string, uuid, required ## Query parameters - `cursor` string, nullable — An opaque cursor for pagination - `page_size` integer — The number of items per page (must be greater than 0 and less than or equal to 100) - `type` DocumentElementType[], nullable - `index_start` integer, nullable - `index_end` integer, nullable ## Headers - `partition` string, nullable — An optional partition to scope the request to. If omitted, accounts created after 1/9/2025 will have the request scoped to the default partition, while older accounts will have the request scoped to all partitions. Older accounts may opt in to strict partition scoping by contacting support@ragie.ai. Older accounts using the partitions feature are strongly recommended to scope the request to a partition. ## Response `200` Successful Response - ListDocumentElements - `pagination` Pagination, required - `next_cursor` string, nullable - `total_count` integer, required - `document_elements` ApiDocumentElement[], required - `id` string, uuid, required - `created_at` string, date-time, required - `index` integer, required - `metadata` object, required - `type` 'Caption' | 'Title' | 'Text' | 'UncategorizedText' | 'NarrativeText' | 'Image' | 'FigureCaption' | 'TableCaption' | 'ListItem' | 'Address' | 'EmailAddress' | 'PageBreak' | 'Formula' | 'Table' | 'Header' | 'Footer' | 'Json' | 'AudioTranscriptionSegment' | 'VideoSegment' | 'SubHeader' | 'SectionHeader' | 'Author' | 'CalendarDate' | 'Quote' | 'Comment' | 'UnorderedList' | 'OrderedList' | 'DefinitionList' | 'Figure' | 'Stamp' | 'Logo' | 'Watermark' | 'Barcode' | 'QrCode' | 'Signature' | 'KeyValue' | 'FormField' | 'Code' | 'Bibliography' | 'TableOfContents' | 'Footnote' | 'Time' | 'Button' | 'Video', required - `text` string, nullable, required - `markdown` string, nullable, required - `location` union - BoundingBoxLocation — Location within a paginated document using normalized coordinates. - `location_type` 'bounding_box' - `left` number, required — Left coordinate (0.0 to 1.0) - `top` number, required — Top coordinate (0.0 to 1.0) - `width` number, required — Width of the element (0.0 to 1.0) - `height` number, required — Height of the element (0.0 to 1.0) - `page_number` integer, required — Page number - SpreadsheetLocation — Location within a spreadsheet using cell ranges. - `location_type` 'spreadsheet' - `range` string, nullable — Excel-style range like 'A1:C10' - `sheet_name` string, nullable — Name of the sheet - `sheet_index` integer, nullable — 0-based index of the sheet - CharacterIndexLocation — Location within linear text using zero-based character offsets. - `location_type` 'character_index' - `start_char_index` integer, required — Start character index (inclusive) - `end_char_index` integer, required — End character index (exclusive) - DurationLocation - `location_type` 'duration' - `start_time` number, required - `end_time` number, required - `duration` number, required - `data` union, required - Text - `type` 'Text' - `content` string, required — The text content - `handwritten` boolean — True if handwritten, false otherwise - Header - `type` 'Header' - `content` string, required — The text content - SubHeader - `type` 'SubHeader' - `content` string, required — The text content - Footer - `type` 'Footer' - `content` string, required — The text content - Title - `type` 'Title' - `content` string, required — The text content - SectionHeader - `type` 'SectionHeader' - `content` string, required — The text content - FigureCaption - `type` 'FigureCaption' - `content` string, required — The text content - Address - `type` 'Address' - `content` string, required — The text content - Author - `type` 'Author' - `content` string, required — The text content - EmailAddress - `type` 'EmailAddress' - `content` string, required — The text content - CalendarDate - `type` 'CalendarDate' - `content` string, required — The text content - Formula - `type` 'Formula' - `content` string, required — The formula as plain text. - `latex` string, nullable — The LaTeX representation of the formula. - Json - `type` 'Json' - `content` string, required — The text content - Quote - `type` 'Quote' - `content` string, required — The text content - Comment - `type` 'Comment' - `content` string, required — The text content - UnorderedList - `type` 'UnorderedList' - `content` string, required — The text content of the list and each list item. - OrderedList - `type` 'OrderedList' - `content` string, required — The text content of the list and each list item. - DefinitionList - `type` 'DefinitionList' - `content` string, required — The text content of the list and each item. - Table - `type` 'Table' - `content` string, required — The Table in HTML. - `description` string, required — A brief summary of the content in the table. - `header_range` string, nullable — Optional normalized header rows range used for construction. - Figure - `type` 'Figure' - `content` string, required — The text visible inside the visual (OCR) - `description` string, required — A detailed description of what the visual depicts. - `base64_data` string, nullable - Stamp - `type` 'Stamp' - `content` string — The text inside the stamp - `description` string — A detailed description of what the visual depicts. - Logo - `type` 'Logo' - `content` string — The text visible inside the logo (OCR) - `description` string, required — A detailed description of the logo - `base64_data` string, nullable - Watermark - `type` 'Watermark' - `content` string, required — The text content - Barcode - `type` 'Barcode' - `content` string, required — The nearby text content of the barcode - QRCode - `type` 'QrCode' - `content` string, required — The value the QR code represents - Signature - `type` 'Signature' - `content` string, required — Content of the signature. - `description` string, required — A detailed description of the signature. - `label` string, required — The printed text indicating who should sign (e.g., 'Driver Signature', 'Authorized By'). - `is_signed` boolean, required — True if a handwritten signature, digital signature, or stamp is present. False if blank. - `signer_name` string, nullable — The name of the signer - `date` string, nullable — The date of the signature if present - KeyValue - `type` 'KeyValue' - `key` string, required — The label/attribute name (e.g. 'Date', 'Invoice #'). - `value` string, required — The static text value found. - FormField - `type` 'FormField' - `content` string, required — The text content of the form field, including both the label and the value - `input_type` 'text' | 'textarea' | 'checkbox' | 'radio' | 'checkbox-group' | 'radio-group' | 'date' | 'time' | 'date-time', required — Type of input. - `label` string, required — The main question/label for the field. - `value` string, nullable — The filled text. For single checkbox: 'true'/'false'. - `options` FormOption[], nullable — List of available options. - `label` string, required — The text label visible next to the checkbox/radio. - `selected_values` string[], nullable — The 'label' of the selected option(s). - `help_text` string, nullable — The help text for the form field. - Code - `type` 'Code' - `content` string — The content of the code - `language` string — The language the code is written in - Bibliography - `type` 'Bibliography' - `content` string, required — The text content of the bibliography. - TableOfContents - `type` 'TableOfContents' - `content` string, required — Text content of the table of contents - Footnote - `type` 'Footnote' - `content` string, required — The text content inside the footnote - Time - `type` 'Time' - `content` string, required — The time text content - Button - `type` 'Button' - `content` string, required — The text content inside the button - Video - `type` 'Video' - `content` string, required — A description of what the video shows. - AudioTranscriptionSegment - `content` string, nullable - `modality_data` WordModality[], required — A list of information per word that shows the word, start time, and end time - `word` string, required - `probability` number, required - `start` number, required - `end` number, required - Caption - `content` string, required — The text content - Image - `type` 'Image' - `content` string, required — The text visible inside the visual (OCR) - `description` string, required — A detailed description of what the visual depicts. - `base64_data` string, nullable — Base64 encoded image data, when available. - ListItem - `type` 'ListItem' - `content` string, required - NarrativeText - `type` 'NarrativeText' - `content` string, required — The text content - PageBreak - `type` 'PageBreak' - UncategorizedText - `content` string, required — The text content - VideoSegment - `content` string, nullable ## Other responses - `401` — Unauthorized - `402` — Payment Required - `422` — Validation Error - `429` — Too Many Requests - `500` — Internal Server Error --- [API](https://skmtc.dev/ragie/apis/ragie-api.md) · [All operations](https://skmtc.dev/ragie/apis/ragie-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ragie/ragie-api/revisions/ffdf960539ca/schema)