Delete a ChatKit thread

beta.chatkit.threads.delete(

thread_id

DELETE

/chatkit/threads/{thread_id}

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

thread_id: str

class ThreadDeleteResponse: …

Confirmation payload returned after deleting a thread.

id: str

Identifier of the deleted thread.

deleted: bool

Indicates that the thread has been deleted.

object: Literal["chatkit.thread.deleted"]

Type discriminator that is always chatkit.thread.deleted.

Python

from openai import OpenAI

client = OpenAI()
thread = client.beta.chat_kit.threads.delete(
    "cthr_123",
)
print(thread.id)

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

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