Documents

Read a document header and its indexer runs

Part of the document pipeline — answers 503 feature_disabled until DOCUMENT_INGEST_ENABLED=1. Source: src/documents/documents.controller.ts.

Required scope: brain:read.

get/v1/documents/{id}

Request

  • Base URL: https://brain.inite.ai
  • URL: https://brain.inite.ai/v1/documents/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The document id.

Query parameters

includeText'1'

Pass 1 to include the stored chunks. The raw text can carry any PII, so this additionally requires the brain:read_pii scope (403 otherwise).

Response

The document.

charLeninteger required
chunkCountinteger required
contentHashstring required
hasContentboolean required
idstring required
kindstring required
metaobject
occurredAtstring date-time required
recorderstring
statusstring required
userIdstring

Per-user memory scope (0128); absent = tenant-global.

verticalstring required

Changes

No recorded changes to this operation across all 1 revision of this API.