Skip to main content

Append document extraction to a session

POST 
/documents/append

Used to extract data from a document and append the results to an existing session. The session ID must be supplied as a header because of the payload format, and the session must be valid and not expired.

This endpoint has similar behaviour to the singular document extraction endpoint, but associates the extracted data with the specified session.

Supports the RFC7240 Prefer header for document class and context preferences. See the singular extraction endpoint for details.

This is the only endpoint that honours review=interactive, which states that the caller will review an unrecognised or failing document itself, over a WebSocket connection, rather than have it queued for Onteric's internal review pipeline. The response is unchanged and still reports REVIEW_PENDING, but nothing is queued and starting the review is left to the caller. The preference is honoured only for clients granted the review:interactive scope with file retention enabled; otherwise it is ignored, or a 412 response is returned if it was combined with handling=strict. review is echoed in Preference-Applied only when the preference was actually honoured.

Request​

Responses​

Document extraction completed without error