Library

Get document

Gets one Discovery document's metadata, and optionally its extracted text.

GET/api/v1/documents/{document_id}

Authorization

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your Sentinel API key. See Authentication.

document_idstringpathrequired≤ 64 characters

The document's ID, as a list or search returned it.

includestringquery

text adds the document's extracted text, up to 500,000 characters.

One of text

200 · The document.

idstringrequired

matter_idstringrequired

file_namestringrequired

document_typestring | nullrequired

For example email, attachment or file.

mime_typestring | nullrequired

file_sizeinteger | nullrequired

Bytes.

page_countinteger | nullrequired

custodianstring | nullrequired

parent_document_idstring | nullrequired

For an attachment, the email it belongs to.

bates_numberstring | nullrequired

emailobject | nullrequired

Email envelope, when the document is an email.

Fields

subjectstring | null

senderstring | null

recipientsstring[] | null

sent_atstring (date-time) | null

document_datestring (date-time) | nullrequired

uploaded_atstring (date-time) | nullrequired

textstring | null

Extracted text. Only with include=text. Null when the document has no text yet.

text_truncatedboolean

Only with include=text. true when the text was cut at 500,000 characters.

Status	Type	When
`400`	`invalid_request`	Invalid parameters.
`401`	`authentication_required`	Missing, invalid, revoked or expired API key.
`403`	`permission_denied`	The key's role can't use the API.
`404`	`not_found`	No such document, or the caller can't see it.
`429`	`rate_limited`	More than 120 requests in a minute from one key. Retry after the `Retry-After` header's seconds.