Skip to content
Primary navigation

Delete ChatKit thread

beta.chatkit.threads.delete(strthread_id) -> ThreadDeleteResponse
DELETE/chatkit/threads/{thread_id}

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

ParametersExpand Collapse
thread_id: str
ReturnsExpand Collapse
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.

Delete ChatKit thread

from openai import OpenAI

client = OpenAI()
thread = client.beta.chat_kit.threads.delete(
    "cthr_123",
)
print(thread.id)
{
  "id": "id",
  "deleted": true,
  "object": "chatkit.thread.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "chatkit.thread.deleted"
}