Retrieves a document using either the internal Customerly document ID or your custom identifier.

Document Identification

You can retrieve a document using two types of identifiers:

1. Customerly Document ID (numeric):

• Use the internal document ID directly (e.g., 12345)
• Example: GET /documents/12345

2. Custom Document ID (prefixed with cid:):

• Use your custom identifier with the cid: prefix
• Example: If your custom_document_id is doc_12345, use GET /documents/cid:doc_12345

Response Field Values

status - Document processing status:

• active: Document is ready and content is available
• processing: Document is being processed (text extraction in progress)
• failed: Processing failed (invalid file or extraction error)
• paused: Document is temporarily paused

ai_training_status - AI training status (only if is_ai_enabled is true):

• to_train: Document needs to be trained for AI
• trained: Document has been successfully trained and is available for AI queries
• to_remove: Document is marked for removal from AI training

Note: AI training is performed asynchronously and may take some time after document creation or update.

Content Visibility

The response includes contact_segment_visibilities and company_segment_visibilities — arrays of
{segment_id, is_inherited} objects that define which contact/company segments can access this document
inside Aura (the AI assistant). Only contacts and companies belonging to those segments will be
able to see and interact with this content through Aura.

• is_inherited: true means the rule was propagated from the parent folder, not set directly on this document.
• An empty array means no restrictions apply (visible to everyone).

Use PUT /documents to update visibilities.