Retrieve a ChatKit thread

Changed on

Retrieve a ChatKit thread by its identifier.

get/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 retrieve.

Response

Success

idstring required

Identifier of the thread.

object'chatkit.thread' required

Type discriminator that is always chatkit.thread.

created_atinteger required

Unix timestamp (in seconds) for when the thread was created.

titlestring nullable required

Optional human-readable title for the thread. Defaults to null when no title has been generated.

userstring required

Free-form string that identifies your end user who owns the thread.

Example response

{
  "id": "cthr_def456",
  "object": "chatkit.thread",
  "created_at": 1712345600,
  "title": "Demo feedback",
  "status": {
    "type": "active"
  },
  "user": "user_456"
}

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