Delete a conversation | OpenAI API (unofficial showcase)

1 parameter

conversation_idstringrequired

The ID of the conversation to delete.

3 status codes

200Success

objectstringrequired

Allowed:conversation.deletedDefault:conversation.deleted

deletedbooleanrequired

idstringrequired

404The conversation was not found.

errorobjectrequired

429The request was rejected because a rate limit was exceeded.

errorobjectrequired

Error handling

A 404 is returned: The conversation was not found. A 429 is returned: The request was rejected because a rate limit was exceeded.

import { Client } from "@octridev/openai";

const client = new Client({
  baseUrl: "https://api.openai.com/v1",
  auth: { bearer: process.env.API_TOKEN },
});

const result = await client.conversations.delete({ conversationId: "9b2f1c10-7a3e-4d54-8c2a-1f6b9e0d4a21" });

{
  "object": "conversation.deleted",
  "deleted": true,
  "id": "550e8400-e29b-41d4-a716-446655440000"
}

Request

Response

Errors