Skip to main content
GET
Read bounded document content

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

documentType
enum<string>

Required with id for an initial read. Omit when continuing with cursor.

Available options:
opportunity_attachment,
workspace_attachment,
session_attachment,
document
id
string

Required with documentType for an initial read. Omit when continuing with cursor.

representation
enum<string>
default:text

Initial-read representation. Omit when continuing with cursor.

Available options:
text,
positioned_text
maxChars
integer
default:100000

Maximum characters returned in this response.

Required range: 1 <= x <= 100000
cursor
string

Opaque continuation token from meta.nextCursor. May be combined only with maxChars.

pageStart
integer

First PDF page to read, inclusive. Omit when continuing with cursor.

Required range: x >= 1
pageEnd
integer

Last PDF page to read, inclusive. Omit when continuing with cursor.

Required range: x >= 1

Response

Document content, processing state, or representation availability state.

data
object
required
meta
object
required