Skip to content

Delete a conversation

client.conversations.delete(stringconversationID, RequestOptionsoptions?): ConversationDeletedResource { id, deleted, object }
DELETE/conversations/{conversation_id}

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

ParametersExpand Collapse
conversationID: string
ReturnsExpand Collapse
ConversationDeletedResource { id, deleted, object }
id: string
deleted: boolean
object: "conversation.deleted"

Delete 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 conversationDeletedResource = await client.conversations.delete('conv_123');

console.log(conversationDeletedResource.id);
{
  "id": "id",
  "deleted": true,
  "object": "conversation.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "conversation.deleted"
}