Skip to content
Primary navigation

Suggested
API Dashboard
API Reference
Conversations

Update a conversation

client.Conversations.Update(ctx, conversationID, body) (*Conversation, error)
POST/conversations/{conversation_id}

Update a conversation

ParametersExpand Collapse
conversationID string
body ConversationUpdateParams
Metadata param.Field[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
type Conversation struct{…}
ID string

The unique ID of the conversation.

CreatedAt int64

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

formatunixtime
Metadata any

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

package main

import (
  "context"
  "fmt"

  "github.com/openai/openai-go"
  "github.com/openai/openai-go/conversations"
  "github.com/openai/openai-go/option"
  "github.com/openai/openai-go/shared"
)

func main() {
  client := openai.NewClient(
    option.WithAPIKey("My API Key"),
  )
  conversation, err := client.Conversations.Update(
    context.TODO(),
    "conv_123",
    conversations.ConversationUpdateParams{
      Metadata: shared.Metadata{
      "foo": "string",
      },
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", conversation.ID)
}

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