v44

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-05-192301780.0 KB
Vaults

Get OCR word bounding boxes

Retrieves word-level OCR bounding box data for a processed PDF document. Each word includes its text, normalized bounding box coordinates (0-1 range), confidence score, and global word index. Use this data to highlight specific text ranges in a PDF viewer based on word indices from search results.

get/vault/{id}/objects/{objectId}/ocr-words

Path parameters

idstring required

The vault ID

objectIdstring required

The object ID

Query parameters

pageinteger

Filter to a specific page number (1-indexed). If omitted, returns all pages.

wordStartinteger

Filter to words starting at this index (inclusive). Useful for retrieving words for a specific chunk.

wordEndinteger

Filter to words ending at this index (inclusive). Useful for retrieving words for a specific chunk.

Response

Successfully retrieved OCR word data

objectIdstring

The object ID

pageCountinteger

Total number of pages in the document

totalWordsinteger

Total number of words extracted from the document

createdAtstring date-time

When the OCR data was extracted