Endpoint reference

The REST API manages deals, forms, submissions and pipeline runs. Set the API host root supplied for your deployment and send the credential with every API request.

Use /openapi.json or /docs on your API host for that deployment's contract. Run a pipeline supplies a complete sequence. Read results covers values, corrections and original documents.

Integration step headers

Pipeline reads mask steps[].integrationConfig.headers values as ••••••••. To keep a stored header when updating a step, send that value back. To replace it, send a new value. On a new step the mask stores an empty value, so send the real one.

Read OCR layout regions

GET /v2/submissions/{submissionId}/extractions/{documentExtractionId}/regions reads the selected extraction's layout regions. The extraction must belong to the submission and your organisation.

The default response contains key, kind, one-based pageNumber and polygon. Pass page to read one page. Table cells form a whole-table region on each page the table spans.

Set includeContent=true with page to request complete stored text, the matching layout node's elementType and confidence where available. kind retains the paragraph, table or region classification used for region picking. Confidence is the stored minimum OCR word confidence for the reference, on a 0–1 scale. Missing confidence and unknown semantic types are omitted. Whole-table text includes the complete table; table confidence is omitted when the table has no stored reference confidence.

Content projection requires page, and returns 400 without it. It also requires a stored PDF or image MIME type. Other formats, missing layouts and inaccessible extractions return 404. Text and spreadsheet layouts use different coordinate systems. The route reads the document's current cached layout.