Skip to content

delete.md

Latest commit

 

History

History
44 lines (28 loc) · 741 Bytes

delete.md

File metadata and controls

44 lines (28 loc) · 741 Bytes

Delete ChatKit thread

delete /chatkit/threads/{thread_id}

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

Path Parameters

  • thread_id: string

Returns

  • 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.

    • "chatkit.thread.deleted"

Example

curl https://api.openai.com/v1/chatkit/threads/$THREAD_ID \
    -X DELETE \
    -H 'OpenAI-Beta: chatkit_beta=v1' \
    -H "Authorization: Bearer $OPENAI_API_KEY"

Response

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