Skip to main content
post/conversations/{conversation_id}/name
Request example
Response
post/conversations/{conversation_id}/name

Authorization

Authorizationstringheaderrequired#

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_idstringrequired#
ID of the conversation to rename. Get conversation IDs from List Conversations.

Body

application/json
auto_generateboolean#
Automatically generate the conversation name. When true, the name field is ignored.

Default: false

namestring#
New conversation name. Required unless auto_generate is true.
userstring#
End-user identifier, defined by your app and unique within it. See End User Identity.

Responses

application/json
Conversation renamed successfully.
created_atinteger#
Creation timestamp.
idstring#
Conversation ID.
inputsobject#
Input variables for the conversation.
introductionstring#
Conversation introduction.
namestring#
Conversation name.
statusstring#
Conversation status. normal for active conversations.
updated_atinteger#
Last update timestamp.