Chunk
/api/v1/knowledge/chunksA chunk of a Document used at retrieval time.
listgetcreatedeletesearchSchema
| 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. |
| document_id | string | ID of the parent Document (doc-<uuid>). |
| chunk_number | number | Sequential position of this chunk within the parent document. |
| text | string | Text content of this chunk. |
| tokens | number | Token count of the chunk text. |
| vector | json | Embedding vector (Array<Float32, 1536>), HNSW-indexed in ClickHouse. |
| embedding_model | string | Embedding model used to generate the vector. |
| chunk_type | string | Structural type of the chunk content. |
| page_number | number | Page number in the source document where this chunk appears. |
| header_path | json | Heading hierarchy leading to this chunk, e.g. ["Section 5", "5.2 Access Control"]. |
| prev_chunk_id | string | ID of the preceding chunk in the document, for sequential traversal. |
| next_chunk_id | string | ID of the following chunk in the document, for sequential traversal. |
| entity_ids | json | IDs of KnowledgeEntity nodes mentioned in this chunk. |
| keywords | json | Extracted keywords from the chunk text. |
| language | string | BCP-47 language tag for this chunk's content. |
| sensitivity | string | Data sensitivity classification for this chunk. |
| status | enum | active | archived | supersededLifecycle status of this chunk. |
API
client.knowledge.chunks.*Loading manifest…