Skip to content
Primary navigation

Delete ChatKit thread

beta.chatkit.threads.delete(thread_id) -> ThreadDeleteResponse { id, deleted, object }
DELETE/chatkit/threads/{thread_id}

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

ParametersExpand Collapse
thread_id: String
ReturnsExpand Collapse
class ThreadDeleteResponse { id, deleted, object }

Confirmation payload returned after deleting a thread.

id: String

Identifier of the deleted thread.

deleted: bool

Indicates that the thread has been deleted.

object: :"chatkit.thread.deleted"

Type discriminator that is always chatkit.thread.deleted.

Delete ChatKit thread

require "openai"

openai = OpenAI::Client.new

thread = openai.beta.chat_kit.threads.delete("cthr_123")

puts(thread)
{
  "id": "id",
  "deleted": true,
  "object": "chatkit.thread.deleted"
}
Returns Examples
{
  "id": "id",
  "deleted": true,
  "object": "chatkit.thread.deleted"
}