API reference
59 endpoints, generated from the OpenAPI contract the hosted API serves. Each page lists parameters, request and response fields, and Python, JavaScript and cURL samples.
This reference covers the endpoints an API key can call. The deployed service also serves routes for the web app, account administration and the platform itself; those need a signed-in session or an operator key and are left out on purpose. See API keys and permissions.
Chat
Ask questions and follow-ups. Every call is scoped to one agent.
Conversations
Read, rename, delete and export saved conversations.
- GET
/v1/sessions/{session_id}/exportExport an answer's rows as CSV - GET
/v1/agents/{agent_id}/sessionsList conversations - GET
/v1/agents/{agent_id}/sessions/{session_id}Get a conversation - PATCH
/v1/agents/{agent_id}/sessions/{session_id}Rename a conversation - DELETE
/v1/agents/{agent_id}/sessions/{session_id}Delete a conversation
Agent
Read and change the agent's own settings.
- GET
/v1/agents/{agent_id}Get the agent - PUT
/v1/agents/{agent_id}Replace the agent's settings - PATCH
/v1/agents/{agent_id}Update the agent's settings - GET
/v1/agents/{agent_id}/configGet the agent's model configuration - POST
/v1/agents/{agent_id}/config/nodesSet per-step model configuration - PATCH
/v1/agents/{agent_id}/config/paramsUpdate agent parameters - DELETE
/v1/agents/{agent_id}/config/nodes/{node_name}Reset a step to its default configuration
Databases
The databases this agent answers from.
- GET
/v1/agents/{agent_id}/databasesList Databases - POST
/v1/agents/{agent_id}/databasesAdd Database - POST
/v1/agents/{agent_id}/databases/checkCheck Databases - POST
/v1/agents/{agent_id}/databases/bulkBulk Import - POST
/v1/agents/{agent_id}/databases/bulk-deleteBulk Delete - POST
/v1/agents/{agent_id}/databases/{db_id}/description/generateGenerate Description - GET
/v1/agents/{agent_id}/databases/{db_id}/description/generate/{job_id}Poll Description - GET
/v1/agents/{agent_id}/databases/{db_id}Get Database - PATCH
/v1/agents/{agent_id}/databases/{db_id}Update Database - DELETE
/v1/agents/{agent_id}/databases/{db_id}Delete Database - PATCH
/v1/agents/{agent_id}/databases/{db_id}/statusUpdate Database Status - PATCH
/v1/agents/{agent_id}/databases/{db_id}/descriptionUpdate Database Description
Tables and columns
Which tables the agent may query, and the descriptions it reads them by.
- GET
/v1/agents/{agent_id}/databases/{db_id}/tablesDb List Tables - POST
/v1/agents/{agent_id}/databases/{db_id}/tablesDb Create Tables - PUT
/v1/agents/{agent_id}/databases/{db_id}/tablesDb Put Tables - DELETE
/v1/agents/{agent_id}/databases/{db_id}/tablesDb Delete Tables - POST
/v1/agents/{agent_id}/databases/{db_id}/tables/generateDb Generate Table Descriptions - GET
/v1/agents/{agent_id}/databases/{db_id}/tables/generate/{job_id}Db Poll Table Descriptions - POST
/v1/agents/{agent_id}/databases/{db_id}/tables/{table_name}/generateDb Generate One Table Description - PATCH
/v1/agents/{agent_id}/databases/{db_id}/tables/{table_name}/visibilityDb Table Visibility - PUT
/v1/agents/{agent_id}/databases/{db_id}/tables/{table_name}Db Update Table Description - GET
/v1/agents/{agent_id}/databases/{db_id}/tables/{table_name}/columnsDb Get Columns - PUT
/v1/agents/{agent_id}/databases/{db_id}/tables/{table_name}/columnsDb Update Columns
Example questions
Question and SQL pairs the agent learns from.
- GET
/v1/agents/{agent_id}/databases/{db_id}/few-shot-examplesGet All Few Shot Examples For Db - POST
/v1/agents/{agent_id}/databases/{db_id}/few-shot-examplesCreate Few Shot Examples For Db - PUT
/v1/agents/{agent_id}/databases/{db_id}/few-shot-examplesUpdate Few Shot Examples For Db - DELETE
/v1/agents/{agent_id}/databases/{db_id}/few-shot-examplesDelete Few Shot Examples For Db
Column value lookup
Columns whose stored values the agent looks up before it writes SQL.
- GET
/v1/agents/{agent_id}/databases/{db_id}/tables/high-cardinality-columnsGet High Cardinality Columns For Db - POST
/v1/agents/{agent_id}/databases/{db_id}/tables/high-cardinality-columnsSet High Cardinality Columns For Db - DELETE
/v1/agents/{agent_id}/databases/{db_id}/tables/high-cardinality-columnsDelete High Cardinality Columns For Db - GET
/v1/agents/{agent_id}/databases/{db_id}/tables/hc-profileGet All Hc Profiles For Db - POST
/v1/agents/{agent_id}/databases/{db_id}/tables/hc-profileTrigger Hc Profile For Db - DELETE
/v1/agents/{agent_id}/databases/{db_id}/tables/hc-profileDelete All Hc Profiles For Db - GET
/v1/agents/{agent_id}/databases/{db_id}/tables/{table_name}/hc-profileGet Table Hc Profile For Db - DELETE
/v1/agents/{agent_id}/databases/{db_id}/tables/{table_name}/hc-profileDelete Table Hc Profile For Db
Analytics
How the agent is being used and where it fails.
Chat widget
The embeddable chat widget's appearance.