Knowledge base records
Reading records across knowledge bases. Writing goes through the base that holds them.
Search all records
Read-only, and flat rather than nested under a knowledge base, because the queries it exists for span several — by name, by category, or by a list of ids. Records are created and edited through their own knowledge base.
query Parameters
cursor^[A-Za-z0-9_-]+$data_activedata_createddata_iddata_titledata_updatedds_categoryds_idds_nameds_typedsi_embedding_modellimitoffsetsort^-?[a-z0-9_]+$summaryHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Search all records › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
List records
Returns the records in one knowledge base. To search across every base at once, use GET /knowledge-base-records.
path Parameters
idquery Parameters
cursor^[A-Za-z0-9_-]+$data_activedata_createddata_iddata_titledata_updatedds_categoryds_idds_nameds_typedsi_embedding_modellimitoffsetsort^-?[a-z0-9_]+$summaryHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
List records › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Add a record
Its fields are the shape the knowledge base's schema declares.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Add a record › Request Body optional
data_titledata_repodata_contentdata_formdata_metadatadata_acldata_chunkdata_embedding_modelAdd a record › Responses
Created
data_iddata_titledata_repodata_contentdata_formdata_metadatadata_activedata_createddata_updateddata_excerptDelete all records
Empties it without deleting the knowledge base. Not reversible.
path Parameters
idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete all records › Responses
Success
Get a record
Returns one record, shaped by the form its knowledge base was created with.
path Parameters
idrecord_idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Get a record › Responses
Success
data_iddata_titledata_repodata_contentdata_formdata_metadatadata_activedata_createddata_updateddata_excerptDelete a record
Deactivates the record. It stops being returned and stops being retrieved by agents.
path Parameters
idrecord_idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Delete a record › Responses
Success. No content.
Update a record
Applies the data_-prefixed fields present in the body. Editing the content re-embeds the record, so retrieval sees the change without a reindex.
path Parameters
idrecord_idHeaders
X-Tenant-IdThe workspace this request acts in. Every row the API returns is isolated to it at the database layer by row-level security.
Update a record › Request Body optional
data_titledata_activedata_repodata_contentdata_formdata_metadataUpdate a record › Responses
Success
data_iddata_titledata_repodata_contentdata_formdata_metadatadata_activedata_createddata_updateddata_excerpt