Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Delete a ChatKit thread

client.beta.chatkit.threads.delete(stringthreadID, RequestOptionsoptions?): ThreadDeleteResponse { id, deleted, object }
DELETE/chatkit/threads/{thread_id}

Delete a ChatKit thread along with its items and stored attachments.

ParametersExpand Collapse
threadID: string
ReturnsExpand Collapse
ThreadDeleteResponse { id, deleted, object }

Confirmation payload returned after deleting a thread.

id: string

Identifier of the deleted thread.

deleted: boolean

Indicates that the thread has been deleted.

object: "chatkit.thread.deleted"

Type discriminator that is always chatkit.thread.deleted.

Delete a ChatKit thread

import OpenAI from 'openai';

const client = new OpenAI();

const thread = await client.beta.chat_kit.threads.delete('cthr_123');

console.log(thread.id);

{
  "id": "cthr_123",
  "object": "chatkit.thread.deleted",
  "deleted": true
}
Returns Examples
{
  "id": "cthr_123",
  "object": "chatkit.thread.deleted",
  "deleted": true
}