Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
Body
application/json
Response
Successful Response
assistants
api-keys
conversations
chatbots
data
data-dictionary
datasets
dashboards
credit-usage
secrets
- GETRetrieve metadata for a secret
- DELDelete an existing secret entry in the DB. This will also delete the associated secret in the cloud provider's secret manager.
- GETRetrieve all secrets for an organization.
- POSTCreate a new secret entry in the DB. These are typically used/needed to access datasets in protected cloud storage.
pipelines
automations
automation-sessions
classification-classes
- GETGet a list of all available classification class hierarchies
- POSTCreate a classification class hierarchy
- GETGet an existing classification class hierarchy
- DELDelete an existing classification class hierarchy
- PATCHUpdate a classification class hierarchy
- POSTCreate a classification class hierarchy from a CSV file
user
organisations
inference
tagging-lists
notebook-services
tasks
agents
admin-organisations
Copy
{
"response": "<string>"
}data
Query Collection Endpoint
Executes a collection query by retrieving all rows from the dataset (excluding the _embedding_vec column) and building an XML context from the query results. The context is then passed to the chatbot for response generation.
Request payload:
- dataset_id: The dataset ID to query.
- messages: A list of messages forming the conversation. The conversation must end with a user message.
POST
/
data
/
query-collection
Copy
{
"response": "<string>"
}Assistant
Responses are generated using AI and may contain mistakes.