v1

latestOpenAPI 3.1.02026-08-04282319386.0 KB

Chat Explore

Submit Chat Explore Query

Query Chat Explore through API. Takes in a list of messages and gives you the message Chat Explore sent back.

post/api/v1/chat-explore/new

Request body

project_idstring nullable

The project ID which you want to run a Chat Explore query against. Either this or dataset_id must be specified; if this is specified, custom instructions attached to the project will be provided as context to the query.

dataset_idstring nullable

The dataset ID which you want to run a Chat Explore query against. Either this or project_id must be specified.

chatContextstring

Anything you'd like Chat Explore to know about this application to provide better responses. For example: (1) This dataset is customer engagement data, (2) The units of the sales column are in millions, (3) The data is messy and contains typos

chatInstructionsstring

Response

Successful Response

task_idstring required

The ID of the task that was started. This is generally queryable at a nearby /status endpoint to get the current status of the task.