API Reference

Conversations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update a conversation

$ openai conversations update

POST/conversations/{conversation_id}

Update a conversation

ParametersExpand Collapse

--conversation-id: string

The ID of the conversation to update.

--metadata: map[string]

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

conversation: object { id, created_at, metadata, object }

id: string

The unique ID of the conversation.

created_at: number

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

metadata: unknown

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: "conversation"

The object type, which is always conversation.

Update a conversation

CLI Tool

HTTP

TypeScript

Python

Java

Go

Ruby

CLI Tool

openai conversations update \
  --api-key 'My API Key' \
  --conversation-id conv_123 \
  --metadata '{foo: string}'

{
  "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"}
}