POST
/
api
/
topic
Create Topic
curl --request POST \
  --url https://api.trieve.ai/api/topic \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --header 'TR-Dataset: <tr-dataset>' \
  --data '{
  "first_user_message": "<string>",
  "metadata": "<any>",
  "name": "<string>",
  "owner_id": "<string>"
}'
{
  "created_at": "2021-01-01 00:00:00.000",
  "dataset_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "deleted": false,
  "id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "name": "Trieve",
  "owner_id": "e3e3e3e3-e3e3-e3e3-e3e3-e3e3e3e3e3e3",
  "updated_at": "2021-01-01 00:00:00.000"
}

Authorizations

​
Authorization
string
header
required

Headers

​
TR-Dataset
string
required

The dataset id or tracking_id to use for the request. We assume you intend to use an id if the value is a valid uuid.

Body

application/json

JSON request payload to create chat topic

​
owner_id
string
required

The owner_id of the topic. This is typically a browser fingerprint or your user's id. It is used to group topics together for a user.

​
first_user_message
string | null

The first message which will belong to the topic. The topic name is generated based on this message similar to how it works in the OpenAI chat UX if a name is not explicitly provided on the name request body key.

​
metadata
any

Metadata is any metadata you want to associate w/ the event that is created from this request

​
name
string | null

The name of the topic. If this is not provided, the topic name is generated from the first_user_message.

Response

200
application/json

The JSON response payload containing the created topic

​
created_at
string
required
​
dataset_id
string
required
​
deleted
boolean
required
​
id
string
required
​
name
string
required
​
owner_id
string
required
​
updated_at
string
required