Skip to main content
POST
Rename Conversation

Authorizations

Authorization
string
header
required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

conversation_id
string
required

ID of the conversation to rename. Get conversation IDs from List Conversations.

Body

application/json

Request body for renaming a conversation.

name
string

New conversation name. Required unless auto_generate is true.

auto_generate
boolean
default:false

Automatically generate the conversation name. When true, the name field is ignored.

user
string

End-user identifier, defined by your app and unique within it. See End User Identity.

Response

Conversation renamed successfully.

id
string<uuid>

Conversation ID.

name
string

Conversation name.

inputs
object

Input variables for the conversation.

status
string

Conversation status. normal for active conversations.

introduction
string

Conversation introduction.

created_at
integer<int64>

Creation timestamp.

updated_at
integer<int64>

Last update timestamp.