Conversations

Rename conversation

Rename a conversation that you own. Provide the new title in the request body. Returns the updated conversation.

patch/conversations/{conversation_id}

Request

Base URL: https://console.hyperstack.cloud/ai/api/v1
URL: https://console.hyperstack.cloud/ai/api/v1/conversations/{conversation_id}
Auth: API key in header api_key

Path parameters

conversation_idinteger required

Unique identifier of the conversation to rename. Use the id from List conversations.

Request body

titlestring required

The new conversation title. Maximum 255 characters.

Response

The conversation was renamed. Returns the updated conversation.

Example response

{
  "conversation": {
    "id": 1001,
    "title": "Describe the attached image",
    "base_model_id": 1001,
    "user_id": 1001,
    "organization_id": 1001,
    "settings": {},
    "system_prompt_id": null,
    "created_at": "Wed, 15 Jan 2025 10:30:00 GMT",
    "modified_at": "Wed, 15 Jan 2025 10:31:00 GMT",
    "is_deleted": false,
    "deleted_at": null,
    "lorax_model_id": null
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.