Skip to content
API Reference
Conversations

Update a conversation

client.conversations.update(stringconversationID, ConversationUpdateParams { metadata } body, RequestOptionsoptions?): Conversation { id, created_at, metadata, object }
POST/conversations/{conversation_id}

Update a conversation

ParametersExpand Collapse
conversationID: string
body: ConversationUpdateParams { metadata }
metadata: Metadata | null

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

import OpenAI from 'openai';

const client = new OpenAI({
  apiKey: process.env['OPENAI_API_KEY'], // This is the default and can be omitted
});

const conversation = await client.conversations.update('conv_123', { metadata: { foo: 'string' } });

console.log(conversation.id);
{
  "id": "id",
  "created_at": 0,
  "metadata": {},
  "object": "conversation"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "metadata": {},
  "object": "conversation"
}