Skip to content
Primary navigation

Delete ChatKit thread

$ openai beta:chatkit:threads delete
DELETE/chatkit/threads/{thread_id}

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

ParametersExpand Collapse
--thread-id: string

Identifier of the ChatKit thread to delete.

ReturnsExpand Collapse
BetaChatKitThreadDeleteResponse: object { 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 ChatKit thread

openai beta:chatkit:threads delete \
  --api-key 'My API Key' \
  --thread-id cthr_123
{
  "id": "id",
  "deleted": true,
  "object": "chatkit.thread.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "chatkit.thread.deleted"
}