Skip to content

Delete a conversation

ConversationDeletedResource conversations().delete(ConversationDeleteParamsparams = ConversationDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())
DELETE/conversations/{conversation_id}

Delete a conversation. Items in the conversation will not be deleted.

ParametersExpand Collapse
ConversationDeleteParams params
Optional<String> conversationId
ReturnsExpand Collapse
class ConversationDeletedResource:
String id
boolean deleted
JsonValue; object_ "conversation.deleted"constant"conversation.deleted"constant

Delete a conversation

package com.openai.example;

import com.openai.client.OpenAIClient;
import com.openai.client.okhttp.OpenAIOkHttpClient;
import com.openai.models.conversations.ConversationDeleteParams;
import com.openai.models.conversations.ConversationDeletedResource;

public final class Main {
    private Main() {}

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

        ConversationDeletedResource conversationDeletedResource = client.conversations().delete("conv_123");
    }
}
{
  "id": "id",
  "deleted": true,
  "object": "conversation.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "conversation.deleted"
}