Skip to content
Primary navigation
API Dashboard
API Reference
Conversations

Update a conversation

conversations.update(strconversation_id, ConversationUpdateParams**kwargs) -> Conversation
POST/conversations/{conversation_id}

Update a conversation

ParametersExpand Collapse
conversation_id: str
metadata: Optional[Metadata]

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard.

Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

ReturnsExpand Collapse
class Conversation: …
id: str

The unique ID of the conversation.

created_at: int

The time at which the conversation was created, measured in seconds since the Unix epoch.

metadata: object

Set of 16 key-value pairs that can be attached to an object. This can be useful for storing additional information about the object in a structured format, and querying for objects via API or the dashboard. Keys are strings with a maximum length of 64 characters. Values are strings with a maximum length of 512 characters.

object: Literal["conversation"]

The object type, which is always conversation.

Update a conversation

from openai import OpenAI
client = OpenAI()

updated = client.conversations.update(
  "conv_123",
  metadata={"topic": "project-x"}
)
print(updated)

{
  "id": "conv_123",
  "object": "conversation",
  "created_at": 1741900000,
  "metadata": {"topic": "project-x"}
}
Returns Examples
{
  "id": "conv_123",
  "object": "conversation",
  "created_at": 1741900000,
  "metadata": {"topic": "project-x"}
}