Skip to main content
GET
Read a document

Authorizations

Authorization
string
header
required

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

Path Parameters

document_id
integer<int32>
required

The unique ID of the Document

Response

OK

annotation_ids
integer[]
required

Unique IDs of Annotations made on this Document

created_at
string
required

Creation time, by UTC

csl
CSL · object
required

CSL reference info for internal use

doctype
string
required

Type of file, such as pdf, txt, etc.

file_resource_size
integer
required

Size of extracted information

file_size
integer
required

Size of original file

id
integer
required

Unique ID of the Document

is_trash
boolean
required

Is the Document in Workspace trash

meta
Meta · object
required

Metadata, for internal use

modified_at
string
required

Modification time, by UTC

modified_by
integer
required

Last user to modify

organization_id
integer
required

Unique ID of Organization

pages
integer
required

Number of pages in Document

resource_size
integer
required

Internal resource usage

status
Status · object
required

Processing status of Document

tag_ids
integer[]
required

IDs of tags on this Document

ui
UI · object
required

UI information for internal use

use_ocr
boolean
required

Whether or not to use OCR on this Document. Leave as False except for images

user
UserSimple · object
required
annotations
Annotation · object[]

Detailed Annotations made on this Document

comments
Comment · object[]

Detailed comments made on the Annotations

filename
string

Name of original file

keywords
any[]

Keywords for internal use

ranking
integer

Search ranking if applicable

resource_stats
DocumentResourceStats · object

Detailed description of disk usage by a given Document

snippet
string

Snippet found through search, if applicable

span
integer[]

For UI use

suggested_tags
SuggestedTag · object[]

Auto suggested tags

tasks
Task · object[]

Queued tasks associated with this Document