Documents

Get a document by ID

Retrieves a document by its unique identifier.

get/api/v0/documents/{document_id}

Path parameters

document_idstring uuid required

Successful Response

idstring uuid required

The ID of the document.

namestring required

The name of the document.

folder_idstring uuid nullable required

The ID of the folder that contains the document.

file_pathstring nullable required

The path to the document file.

file_typestring required

The type of the document file. Options: pdf, docx, txt, html, md.

file_urlstring nullable required

The URL of the document file.

summarystring required

A summary of the document content.

visibilitystring required

The visibility of the document. Options: private, org.

num_pagesinteger required

The number of pages in the document.

versioninteger required

The version of the document.

job_status_idstring uuid nullable

The public UUID of the job status for the document's current processing job.

job_statusstring nullable

The current job status: queued, processing, done, error, cancelled.

created_atstring date-time required

The date and time the document was created.

updated_atstring date-time required

The date and time the document was last updated.

tagsstring[] required

The tags associated with the document.