Skip to content
Primary navigation

Delete ChatKit thread

DELETE/chatkit/threads/{thread_id}

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

Path ParametersExpand Collapse
thread_id: string
ReturnsExpand Collapse
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

curl https://api.openai.com/v1/chatkit/threads/$THREAD_ID \
    -X DELETE \
    -H 'OpenAI-Beta: chatkit_beta=v1' \
    -H "Authorization: Bearer $OPENAI_API_KEY"
{
  "id": "id",
  "deleted": true,
  "object": "chatkit.thread.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "chatkit.thread.deleted"
}