Conversation

Get Shared Conversation Details

get

Fetch the active share-link details for a conversation without mutating anything.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Path parameters
conversation_idstringRequired
Responses
chevron-right
200

Successful Response

application/json
get
/conversations/{conversation_id}/share

Create Or Update Shared Conversation

post

Create a shareable link for a conversation with optional expiry days.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Path parameters
conversation_idstringRequired
Body
expiry_daysany ofOptional
integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
post
/conversations/{conversation_id}/share

Get Shared Conversation

get

Get a shared conversation by its share ID, including all messages and attachments.

Path parameters
shared_conversation_idstringRequired
Header parameters
Accept-LanguagestringOptionalDefault: en
Responses
chevron-right
200

Successful Response

application/json
get
/conversations/shared/{shared_conversation_id}

Delete Shared Conversation

delete

Delete a shared conversation by its share ID.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Path parameters
shared_conversation_idstringRequired
Responses
chevron-right
200

Successful Response

application/json
delete
/conversations/shared/{shared_conversation_id}

Get All Shared Conversations

get

Get all shared conversations of current user.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Query parameters
queryany ofOptional

Search query for conversation title

stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
get
/conversations/shared

Clone Shared Conversation

post

Clone a shared conversation to a new conversation.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Path parameters
shared_conversation_idstringRequired
Body
user_idstringRequired
new_conversation_idany ofOptional
stringOptional
or
nullOptional
old_parent_idstringRequired
Responses
chevron-right
200

Successful Response

application/json
Responseany
post
/conversations/shared/{shared_conversation_id}/clone

No content

Get All Conversations

get

Get all conversations of current user, optionally filtered by a search query and chatbot_id.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Query parameters
querystringOptional

Search query for conversation title or message content

Default: ""
chatbot_idstringOptional

Chatbot id for conversation

cursorany ofOptional

Pointer to keep track of the last fetched conversations

stringOptional
or
nullOptional
limitany ofOptional

Number of conversations to return per request

integerOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
get
/conversations

Create Conversation

post

Create a new conversation with optional title.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Body
user_idstringRequired
titleany ofOptional
stringOptional
or
nullOptional
model_namestringOptionalDefault: openai/gpt-4o-mini
chatbot_idstringRequired
metadata_any ofOptional
stringOptional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
post
/conversations

Get Conversation Messages

get

Get messages from a specific conversation with optional limit and date filtering.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Path parameters
conversation_idstringRequired
Query parameters
limitany ofOptional
integerOptional
or
nullOptional
max_dateany ofOptional
stringOptional
or
nullOptional
Header parameters
Accept-LanguagestringOptionalDefault: en
Responses
chevron-right
200

Successful Response

application/json
get
/conversations/{conversation_id}

Delete Conversation

delete

Delete a specific conversation by ID and remove any associated attachments and vector DB documents.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Path parameters
conversation_idstringRequired
Responses
chevron-right
200

Successful Response

application/json
delete
/conversations/{conversation_id}

Rename Conversation

patch

Rename an existing conversation with a new title.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Path parameters
conversation_idstringRequired
Body
titlestringRequired
Responses
chevron-right
200

Successful Response

application/json
patch
/conversations/{conversation_id}

Delete Conversations

post

Delete multiple conversations matching the specified criteria, including user_id, chatbot_id and optional conversation_ids.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Body

Request model for deleting conversations.

user_idstringRequired
chatbot_idstringRequired
conversation_idsany ofOptional
string[]Optional
or
nullOptional
Responses
chevron-right
200

Successful Response

application/json
post
/conversations/delete

Generate Conversation Title

post

Generate a title for an existing conversation based on its content.

Authorizations
OAuth2passwordRequired
Token URL:
cookie
__Secure-next-auth.session-tokenany ofOptional
stringOptional
or
nullOptional
Path parameters
conversation_idstringRequired
Body
messagestringRequired
Responses
chevron-right
200

Successful Response

application/json
post
/conversations/{conversation_id}/generate-title

Last updated