Skip to content
API Reference
Conversations

Update a conversation

conversations.update(conversation_id, **kwargs) -> Conversation { id, created_at, metadata, object }
POST/conversations/{conversation_id}

Update a conversation

ParametersExpand Collapse
conversation_id: String
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
class Conversation { id, created_at, metadata, object }
id: String

The unique ID of the conversation.

created_at: Integer

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

metadata: untyped

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

require "openai"

openai = OpenAI::Client.new(api_key: "My API Key")

conversation = openai.conversations.update("conv_123", metadata: {foo: "string"})

puts(conversation)
{
  "id": "id",
  "created_at": 0,
  "metadata": {},
  "object": "conversation"
}
Returns Examples
{
  "id": "id",
  "created_at": 0,
  "metadata": {},
  "object": "conversation"
}