Skip to main content
POST
/
api
/
v1
/
conversations
{
  "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>",
  "workspace_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
object | null

Additional metadata

​
settings
object | null

Conversation settings

​
owner_id
string | null

User ID associated with this conversation

​
messages
MessageCreateRequest · object[] | null

Messages in this conversation

Response

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 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
object | null

Additional metadata

​
settings
object | null

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