Sample - OpenAI API
GET/chatkit/threads/{thread_id}

Retrieve a ChatKit thread

Retrieves a ChatKit thread by its identifier. Supply thread_id to identify the thread you want to inspect. The response includes the thread's creation time, title, current status, and associated end user.

  • RetriesRetries up to 2×, 500ms backoff, 30s timeout.

1 parameter
thread_idstringrequired
The identifier of the ChatKit thread to retrieve.

1 status code
200Returns a ChatKit thread object containing its identifier, object type, creation timestamp, title, current status, and associated user.
idstringrequired
Identifier of the thread.
objectstringrequired
Type discriminator that is always `chatkit.thread`.
Allowed:chatkit.threadDefault:chatkit.thread
created_atintegerrequired
Unix timestamp (in seconds) for when the thread was created.
titlestringrequired
Optional human-readable title for the thread. Defaults to null when no title has been generated.
statusobjectrequired
Current status for the thread. Defaults to `active` for newly created threads.
userstringrequired
Free-form string that identifies your end user who owns the thread.

Error handling

thread_id must identify the ChatKit thread you want to retrieve. The response represents the thread with an active default status for newly created threads and may contain a null title.