API Reference

Conversations

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Update a conversation

Conversation conversations().update(ConversationUpdateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/conversations/{conversation_id}

Update a conversation

ParametersExpand Collapse

ConversationUpdateParams params

Optional<String> conversationId

Optional<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:

String id

The unique ID of the conversation.

long createdAt

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

JsonValue 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.

JsonValue; object_ "conversation"constant"conversation"constant

The object type, which is always conversation.

Update a conversation

Java

HTTP

TypeScript

Python

Java

Go

Ruby

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.core.JsonValue;
import com.openai.models.conversations.Conversation;
import com.openai.models.conversations.ConversationUpdateParams;

public final class Main {
    private Main() {}

    public static void main(String[] args) {
        OpenAIClient client = OpenAIOkHttpClient.fromEnv();

        ConversationUpdateParams params = ConversationUpdateParams.builder()
            .conversationId("conv_123")
            .metadata(ConversationUpdateParams.Metadata.builder()
                .putAdditionalProperty("foo", JsonValue.from("string"))
                .build())
            .build();
        Conversation conversation = client.conversations().update(params);
    }
}

200 example

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

Returns Examples

200 example

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