Delete a ChatKit thread

Changed on

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

delete/chatkit/threads/{thread_id}

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/chatkit/threads/{thread_id}
  • Auth
    HTTP bearer

Path parameters

thread_idstring required
Example:cthr_123

Identifier of the ChatKit thread to delete.

Response

Success

idstring required

Identifier of the deleted thread.

object'chatkit.thread.deleted' required

Type discriminator that is always chatkit.thread.deleted.

deletedboolean required

Indicates that the thread has been deleted.

Changes

  • e2f8d8cbc41fRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • d86203de41aeRevision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status