Delete a ChatKit thread | OpenAI API (unofficial showcase)

1 parameter

thread_idstringrequired

Identifier of the ChatKit thread to delete.

4 status codes

200Success

idstringrequired

Identifier of the deleted thread.

objectstringrequired

Type discriminator that is always `chatkit.thread.deleted`.

Allowed:chatkit.thread.deletedDefault:chatkit.thread.deleted

deletedbooleanrequired

Indicates that the thread has been deleted.

400The request is invalid or the required ChatKit beta header is missing or invalid.

errorobjectrequired

404The thread was not found or is not accessible.

errorobjectrequired

429The request rate limit has been exceeded.

errorobjectrequired

Error handling

A 400 is returned: The request is invalid or the required ChatKit beta header is missing or invalid. A 404 is returned: The thread was not found or is not accessible. A 429 is returned: The request rate limit has been exceeded.

import { Client } from "openai-api";

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

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

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

Request

Response

Errors