Skip to navigation

Switch chat branch

View as Markdown

Shows another version of a conversation. A conversation branches when a user edits a message they sent: the old message and its replies stay as another version. This makes the newest message under message_id the end of the conversation and returns the thread in the same shape as getting the conversation. Returns 400 edit_unsupported when the agent does not support edits, 404 for a message outside the conversation, and 409 turn_in_progress while a reply is in progress.

Authentication

AuthorizationBearer
OAuth 2.0 device flow or platform session token

Path parameters

deploymentIdstringRequired
Deployment ID
conversationIdstringRequired

Conversation ID (client-chosen UUID v4)

Request

This endpoint expects an object.
message_idstringRequired
A message on the version to show. The newest message under it becomes the end of the conversation.

Response

The conversation on the chosen branch
conversation_idstringOptional
titlestringOptional
updated_atdatetimeOptional
assistant_streamingbooleanOptional
messageslist of objectsOptional
The conversation's active branch, oldest first.
has_morebooleanOptional

Present when a page was returned; more (older) messages exist.

oldest_seqintegerOptional

Sequence number of the oldest message in this page (pagination cursor).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
500
Internal Server Error