Read bounded document content
Reads a bounded portion of an authorized document without creating an analysis or enqueueing extraction work. Start a read with documentType and id. Continue when meta.hasMore is true by sending only meta.nextCursor and, optionally, maxChars. Cursors are opaque, source-bound, and re-authorized on every request. Opportunity document IDs are OppAttachment.id values returned as opportunity attachment id; access is derived from any associated opportunity/source path visible to the caller rather than from a client-supplied opportunity ID. Use positioned_text only when data.availableRepresentations advertises it. PDF page ranges are supported with pageStart and pageEnd. Processing and representation_unavailable are successful structured states. Failed or unavailable extraction returns the standard 422 error envelope, inaccessible records return the standard 404 error envelope, and invalid parameters return the standard 422 error envelope.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Required with id for an initial read. Omit when continuing with cursor.
opportunity_attachment, workspace_attachment, session_attachment, document Required with documentType for an initial read. Omit when continuing with cursor.
Initial-read representation. Omit when continuing with cursor.
text, positioned_text Maximum characters returned in this response.
1 <= x <= 100000Opaque continuation token from meta.nextCursor. May be combined only with maxChars.
First PDF page to read, inclusive. Omit when continuing with cursor.
x >= 1Last PDF page to read, inclusive. Omit when continuing with cursor.
x >= 1