Knowledge bases
The sets of records agents retrieve from.
List knowledge bases
Returns the workspace's knowledge bases. Where a base is backed by a record schema, the schema's id and name are included as form_id and form_name.
query Parameters
cursor^[A-Za-z0-9_-]+$ds_activeds_categoryds_createdds_descriptionds_idds_nameds_subcategoryds_typeds_updatedlimitoffsetsort^-?[a-z0-9_]+$Headers
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 knowledge bases › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Create a knowledge base
Names must be unique in the workspace — they are how agents refer to a knowledge base.
Headers
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.
Create a knowledge base › Request Body
ds_nameds_descriptionds_typeds_categoryds_subcategoryds_configCreate a knowledge base › Responses
Created
ds_idds_nameds_descriptionds_typeds_categoryds_subcategoryds_configds_metadatads_activeds_createdds_updatedform_idThe knowledge base's record schema — see GET /knowledge-base-schemas/{id}. Null unless the base is form-backed.
form_nameform_managed_byGet a knowledge base
Returns the knowledge base with its type, its category and the form its records are shaped by.
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.
Get a knowledge base › Responses
Success
ds_idds_nameds_descriptionds_typeds_categoryds_subcategoryds_configds_metadatads_activeds_createdds_updatedform_idThe knowledge base's record schema — see GET /knowledge-base-schemas/{id}. Null unless the base is form-backed.
form_nameform_managed_byDelete a knowledge base
Agents pointing at it stop retrieving from it. Check before removing one that is in use.
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 a knowledge base › Responses
Success. No content.
Update a knowledge base
Applies the ds_-prefixed fields present in the body. A base's name must stay unique within the workspace.
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.
Update a knowledge base › Request Body optional
ds_nameds_descriptionds_typeds_categoryds_subcategoryds_configUpdate a knowledge base › Responses
Success
ds_idds_nameds_descriptionds_typeds_categoryds_subcategoryds_configds_metadatads_activeds_createdds_updatedform_idThe knowledge base's record schema — see GET /knowledge-base-schemas/{id}. Null unless the base is form-backed.
form_nameform_managed_byExport records
Returns every record in the base as a file, for moving it elsewhere or keeping a copy.
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.
Export records › Responses
Success
List knowledge base files
The documents this knowledge base indexes. Reading them is reading the knowledge base, so its own access rules apply on top of each file's.
Requires any one of media:view, document:view, knowledge-base:view, thread:view, design:view, prompt:view or presentation:view.
path Parameters
idquery Parameters
cursor^[A-Za-z0-9_-]+$file_added_byfile_createdfile_hashfile_idfile_namefile_provider_idfile_statusfile_typefile_updatedlimitoffsetrepo_idrepo_typesort^-?[a-z0-9_]+$Headers
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 knowledge base files › Responses
Success
has_moreWhether more rows exist past this page.
next_cursorPass back as cursor for the next page. Null on the last page.
Fork the record schema
A knowledge base built from a standard template shares that template. This copies it into one the workspace owns and re-points the knowledge base and its existing records at the copy — so the shape can be changed without affecting anyone else, and without a later template update overwriting the changes. A few templates are fixed: where a knowledge base is presented on a screen built for its fields, the copy is refused.
Requires both knowledge-base:edit and knowledge-base:schema:edit.
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.
Fork the record schema › Responses
Success
Import records
Bulk load. The payload is size-capped — split a large import rather than sending it in one call.
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.
Import records › Responses
Success
Fill from a website
Crawls a URL and turns what it finds into records. Runs in the background — this returning does not mean the crawl has finished.
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.
Fill from a website › Responses
Success
List Google Fonts
A static catalog of {family, category}, used when picking type in the design tools. Exposes no workspace data.
Headers
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 Google Fonts › Responses
Success