Document
/api/v1/knowledge/documentsA document indexed for search and RAG.
listgetcreateupdatedeleteSchema
| Field | Type | Notes |
|---|---|---|
| id* | uuid | Server-assigned ULID with type prefix (e.g. per_…). |
| tenant_id* | string | Tenant scope — auto-stamped from the caller's JWT. |
| app_id | string | App scope. Stamped ONLY when the caller's JWT was minted for a specific Application (integration API keys). Absent for human-user sessions. Filters reads when present. |
| created_at* | date-time | Server stamp. |
| updated_at* | date-time | Server stamp; updated on every patch. |
| created_by | uuid | Person id from the caller's JWT (sub). |
| updated_by | uuid | Person id from the last writer's JWT (sub). |
| source | string | Provenance tag — defaults to 'edm'. |
| source_type | enum | frontend | backend | server | system | apiWhere the write originated. Defaults to 'api'. |
| is_deleted | boolean | Soft-delete flag. Excluded from default list queries. |
| deleted_at | date-time | Stamped when soft-deleted; null otherwise. |
| deleted_by | uuid | Person id who soft-deleted; null otherwise. |
| schema_version | number | Document schema version. Bumped on incompatible writes. |
| account_id | string | Optional account scope. |
| collection_id | string | Logical grouping, e.g. kb-security, kb-product. |
| kind | string | Document kind classification. |
| title | string | Human-readable document title. |
| description | string | Optional long-form description of the document. |
| mime_type | string | MIME type of the document bytes. |
| size_bytes | number | Size of the document in bytes. |
| file_hash | string | SHA-256 hash of the document bytes, used as a deduplication key. |
| minio_key | string | MinIO object key for the document bytes. Format: cpod-files/{tenantId}/{collectionId}/{docId}/source.{ext}. |
| language | string | BCP-47 language tag for the document content. |
| page_count | number | Number of pages in the document. |
| extractor | string | Extraction pipeline used to process this document. |
| extraction_status | string | Current status of the document extraction pipeline. |
| extracted_at | date-time | ISO 8601 timestamp when extraction completed. |
| chunk_count | number | Cached count of chunks produced from this document. |
| embedding_model | string | Embedding model used to generate chunk vectors. |
| embedding_dimensions | number | Dimensionality of the embedding vectors. |
| chunk_ids | json | Material list of chunk IDs (also derivable from graph edges). |
| entity_ids | json | IDs of extracted KnowledgeEntity nodes (kne-<uuid>). |
| effective_from | date-time | Start of the validity window for policy or contract documents. |
| effective_to | date-time | End of the validity window for policy or contract documents. |
| version | string | Document's own version string, independent of the record version header. |
| parent_document_id | string | ID of the document this one supersedes, if applicable. |
| acl_scope | string | Access control scope for this document. |
| acl_allowed_role_ids | json | Role IDs permitted to access this document when aclScope is restricted. |
| tags | json | Free-form tags for categorisation and search. |
| status | enum | active | archived | draftLifecycle status of this document record. |
API
client.knowledge.documents.*Loading manifest…