Projects
These endpoints allow you to read, update, and delete projects.
Retrieve the data for a given project.
GET /api/v1/projects/{project_id} HTTP/1.1
Host:
Accept: */*
{
"chatContext": "",
"chatInstructions": "",
"chatSuggestions": "",
"id": "text",
"name": "",
"ANY_ADDITIONAL_PROPERTY": "anything"
}Creates a new project.
Foreign key to the organization this object belongs to.
Foreign key to the user this object belongs to.
What would you like Chat Explore to know about this application to provide better responses? For example:
- This dataset is customer engagement data
- The units of the sales column are in millions
- The data is messy and contains typos
""How would you like Chat Explore to respond? For example:
- Respond only in spanish
- Provide short and concise answers only
- Make sure to always include a chart
""Customize the default chat suggestions by writing a list of suggestions separated by newlines. For example:
- What is the average net media cost by campaign ID?
- Make sure to always include a chart
""The name of the flow.
POST /api/v1/projects HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 142
{
"_org": "text",
"_owner": "text",
"chatContext": "",
"chatInstructions": "",
"chatSuggestions": "",
"name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"chatContext": "",
"chatInstructions": "",
"chatSuggestions": "",
"id": "text",
"name": "",
"ANY_ADDITIONAL_PROPERTY": "anything"
}Update the custom instructions attached to a given project. Updates the project with any provided non-null fields and returns the resulting Flow object.
What would you like Chat Explore to know about this application to provide better responses? For example:
- This dataset is customer engagement data
- The units of the sales column are in millions
- The data is messy and contains typos
How would you like Chat Explore to respond? For example:
- Respond only in spanish
- Provide short and concise answers only
- Make sure to always include a chart
Customize the default chat suggestions by writing a list of suggestions separated by newlines. For example:
- What is the average net media cost by campaign ID?
- Make sure to always include a chart
The name of the flow.
PUT /api/v1/projects/{project_id} HTTP/1.1
Host:
Content-Type: application/json
Accept: */*
Content-Length: 124
{
"chatContext": "text",
"chatInstructions": "text",
"chatSuggestions": "text",
"name": "text",
"ANY_ADDITIONAL_PROPERTY": "anything"
}{
"chatContext": "",
"chatInstructions": "",
"chatSuggestions": "",
"id": "text",
"name": "",
"ANY_ADDITIONAL_PROPERTY": "anything"
}Last updated
Was this helpful?