Create Conversation

Create a new conversation. The workspace_id will be automatically set from the current session context.

POST /api/v1/conversations

Create Conversation

cURL

curl --request POST \
  --url https://api.example.com/api/v1/conversations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "title": "<string>",
  "is_public": false,
  "collections": [
    "<string>"
  ],
  "meta_data": {},
  "settings": {},
  "owner_id": "<string>",
  "messages": []
}
'

201

{
  "workspace_id": "<string>",
  "created_at": "<string>",
  "updated_at": "<string>",
  "id": "<string>",
  "title": "<string>",
  "summary": "<string>",
  "status": "active",
  "is_public": false,
  "collections": [
    "<string>"
  ],
  "meta_data": {},
  "settings": {},
  "ended_at": "2023-11-07T05:31:56Z",
  "owner_id": "<string>",
  "created_by": "<string>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

X-Workspace-Id · string | null

The workspace ID

Body

application/json

Schema for creating a conversation request.

title · string · required

Conversation title

is_public · boolean | null · default: false

Whether conversation is public

collections · string[] | null

Collection IDs associated with this conversation

meta_data · Meta Data · object

Additional metadata

settings · Settings · object

Conversation settings

owner_id · string | null

User ID associated with this conversation

messages · MessageCreateRequest · object[] | null

Messages in this conversation

Show child attributes

Response

201

application/json

Successful Response

Schema for reading conversation data.

workspace_id · string · required

Reference to workspace

created_at · string | null

updated_at · string | null

id · string

title · string | null

Conversation title

Maximum string length: 255

summary · string | null

Conversation summary

status · string · default: active

Conversation status

is_public · boolean · default: false

Whether conversation is public

collections · string[] | null

Collection IDs associated with this conversation

meta_data · Meta Data · object

Additional metadata

settings · Settings · object

Conversation settings

ended_at · string<date-time> | null

When the conversation ended

owner_id · string | null

Owner ID associated with this conversation

created_by · string | null

User who created the conversation