Documentation menu

Developer API · resource

Knowledge records

Text snippets embedded for retrieval by AI flows (the RAG source). Each record belongs to a flow and a catalog.

Scope knowledge-records:read for reads · knowledge-records:write for changes

Operations

GET/v1/knowledge-recordsList — see list
POST/v1/knowledge-recordsCreate — see create
GET/v1/knowledge-records/{id}Read — see get
PATCH/v1/knowledge-records/{id}Update — see update
DELETE/v1/knowledge-records/{id}Delete — see delete
Minimal create
curl -X POST https://api2.djcsystem.com/v1/knowledge-records \
  -H "Authorization: Bearer $DJC_TOKEN" -H "Content-Type: application/json" \
  -d '{ "flowId": "…", "catalogId": "…", "input": "…" }'

Fields

Fields you may send on create. Updatable marks fields accepted by PATCH. Anything not listed is server-owned or hidden.

FieldTypeOn createUpdatable
flowIdstringrequiredno
catalogIdstringrequiredyes
inputstringrequiredyes
linkstringoptionalyes

Filters & sorting

FilterableflowIdcatalogId
Sortabledate
Default orderid order

Good to know

  • Embeddings are generated asynchronously after a write; a new record becomes searchable by the flow within seconds.
  • Keep one fact per record. Changing `input` re-embeds automatically.