Projects

These endpoints allow you to read, update, and delete projects.

Get Project

get

Retrieve the data for a given project.

Path parameters

project_idstringRequired

Responses

200

Successful Response

application/json

422

Validation Error

application/json

get

/api/v1/projects/{project_id}

HTTPcURLJavaScriptPython

GET /api/v1/projects/{project_id} HTTP/1.1
Host: 
Accept: */*

{
  "chatContext": "",
  "chatInstructions": "",
  "chatSuggestions": "",
  "id": "text",
  "name": "",
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

Create New Project

post

Creates a new project.

Body

application/json

_orgstringRequired

Foreign key to the organization this object belongs to.

_ownerstringRequired

Foreign key to the user this object belongs to.

chatContextstringOptional

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

Default: ""

chatInstructionsstringOptional

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

Default: ""

chatSuggestionsstringOptional

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

Default: ""

namestringRequired

The name of the flow.

Other propertiesanyOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

post

/api/v1/projects

HTTPcURLJavaScriptPython

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 Project

put

Update the custom instructions attached to a given project. Updates the project with any provided non-null fields and returns the resulting Flow object.

Path parameters

project_idstringRequired

Body

application/json

chatContextany ofOptional

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

stringOptional

or

nullOptional

chatInstructionsany ofOptional

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

stringOptional

or

nullOptional

chatSuggestionsany ofOptional

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

stringOptional

or

nullOptional

nameany ofOptional

The name of the flow.

stringOptional

or

nullOptional

Other propertiesanyOptional

Responses

200

Successful Response

application/json

422

Validation Error

application/json

put

/api/v1/projects/{project_id}

HTTPcURLJavaScriptPython

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"
}

Delete Project

delete

Deletes the project at the given ID.

Path parameters

project_idstringRequired

Responses

200

Successful Response

application/json

Responseany

422

Validation Error

application/json

delete

/api/v1/projects/{project_id}

HTTPcURLJavaScriptPython

DELETE /api/v1/projects/{project_id} HTTP/1.1
Host: 
Accept: */*

No content