Skip to main content

Projects

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

caution

These endpoints are currently in beta and are subject to change as we refine them.

Create, Read, Update, Delete (CRUD)​

Get a Project​

Request:

GET /api/v1/projects/{project_id}

Response:

HTTP 200

{
  "id": "32dd47e5-71b7-46a9-ba30-b478bb4a874f",
  "name": "Different Project Name",
  "chatInstructions": "",
  "chatContext": "",
  "chatSuggestions": ""
}

Create a Project​

Request:

POST /api/v1/projects

{
  "name": "Project Name",
  "_org": "<your org>",
  "_owner": "<your uid>"
}

Response:

HTTP 201

Update a Project​

Update calls may alter any attributes returned in the GET call above, with the exclusion of the id field. Here, we provide an example of updating the name.

Request:

PUT /api/v1/projects/{project_id}

{
  "name": "Different Project Name"
}

Response:

HTTP 201

{
  "id": "32dd47e5-71b7-46a9-ba30-b478bb4a874f",
  "name": "Different Project Name",
  "chatInstructions": "",
  "chatContext": "",
  "chatSuggestions": ""
}

This call is commonly used to update the "Custom Instruction" fields - see the "Custom Instructions" section below.

Delete a Project​

Request:

DELETE /api/v1/projects/{project_id}

Response:

HTTP 200

Custom Instructions​

A common use case of these endpoints is modifying the Custom Instruction fields that our Chat Explore endpoints use to provide Chat Explore with more context.

note

Chat Explore calls will only use the custom instructions linked to this project if you pass the project_id parameter to that call rather than the dataset_id parameter.

A call to update these might look like:

PUT /api/v1/projects/{project_id}

{
  "chatInstructions": "",
  "chatContext": "This dataset is intended for lead scoring so that we can evaluate which of our customers may be best to focus our sales efforts on.",
  "chatSuggestions": ""
}
Last updated on