Skip to content
API Reference
Conversations

Update a conversation

POST/conversations/{conversation_id}

Update a conversation

Path ParametersExpand Collapse
conversation_id: string
Body ParametersJSONExpand Collapse
metadata: 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
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

curl https://api.openai.com/v1/conversations/$CONVERSATION_ID \
    -H 'Content-Type: application/json' \
    -H "Authorization: Bearer $OPENAI_API_KEY" \
    -d '{
          "metadata": {
            "foo": "string"
          }
        }'
{
  "id": "id",
  "created_at": 0,
  "metadata": {},
  "object": "conversation"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "metadata": {},
  "object": "conversation"
}