Dify Octri Demo
POST/conversations/{conversation_id}/name

Rename Conversation

Available for: Chatflow, Agent, Chatbot, Legacy Agent apps.

Renames a conversation, or auto-generates a name from its messages when auto_generate is true. The name is what clients display in a multi-conversation list.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

1 parameter · 3 body fields
conversation_idstringrequired
ID of the conversation to rename. Get conversation IDs from [List Conversations](/en/api-reference/conversations/list-conversations).
auto_generatebooleanoptional
Automatically generate the conversation name. When `true`, the `name` field is ignored.
Default:false
namestringoptional
New conversation name. Required unless `auto_generate` is `true`.
userstringoptional
End-user identifier, defined by your app and unique within it. See [End User Identity](/en/api-reference/guides/end-user-identity).

3 status codes
200Conversation renamed successfully.
created_atintegeroptional
Creation timestamp.
idstringoptional
Conversation ID.
inputsobjectoptional
Input variables for the conversation.
introductionstringoptional
Conversation introduction.
namestringoptional
Conversation name.
statusstringoptional
Conversation status. `normal` for active conversations.
updated_atintegeroptional
Last update timestamp.
400- `not_chat_app` : App mode does not match the API route. - `invalid_param` : `auto_generate` is `true` but the conversation has no messages to generate a name from.

2 documented failures

  • invalid_param

    invalid_param

  • not_chat_app

    Please check if your app mode matches the right API route.

    not_chat_app

404`not_found` : Conversation does not exist.

One documented failure

  • not_found

    Conversation Not Exists.

    not_found

Error handling

A 400 is returned: - not_chat_app : App mode does not match the API route.

  • invalid_param : auto_generate is true but the conversation has no messages to generate a name from. A 404 is returned: not_found : Conversation does not exist.