KnowledgeEntity
/api/v1/knowledge/entitiesA named entity extracted from documents.
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. |
| type | string | Semantic type of this knowledge entity. |
| domain | string | Knowledge domain this entity belongs to. |
| name | string | Human-readable display name. |
| canonical_name | string | Normalised name (lowercased, deduped) used for deduplication. |
| aliases | json | Alternative names or synonyms for this entity. |
| description | string | Optional description of this entity. |
| confidence | number | Extraction confidence score in the range [0, 1]. |
| document_ids | json | IDs of source documents where this entity was mentioned. |
| chunk_ids | json | IDs of chunks where this entity appears. |
| attributes | json | Domain-specific attributes, e.g. { severity, cvss_score, mitre_tactic, control_id, ... }. |
| version_info | string | Version string for versioned entities (e.g. CVE-2024-12345 → 2024-12345). |
| is_valid | boolean | True until this entity is superseded by a newer version. |
| last_seen_at | date-time | ISO 8601 timestamp when this entity was last observed in a document. |
| tags | json | Free-form tags for categorisation. |
| status | enum | active | merged | archivedLifecycle status of this knowledge entity. |
API
client.knowledge.entities.*Loading manifest…