GET/chatkit/threads/{thread_id}

Retrieve a ChatKit thread

Retrieves a ChatKit thread by its identifier. Use thread_id to select the thread whose status and metadata you need.

1 parameter
thread_idstringrequired
Identifier of the ChatKit thread to retrieve.

4 status codes
200Returns the ChatKit thread object, including its identifier, creation time, title, current status, and user identifier.
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.
400Returned when the request is invalid or the required ChatKit beta header is missing or invalid.
errorobjectrequired
404Returned when the thread is not found or is not accessible.
errorobjectrequired
429Returned when the request rate limit has been exceeded.
errorobjectrequired

Error handling

A 400 is returned when the request is invalid or the required ChatKit beta header is missing or invalid. A 404 is returned when the thread is not found or accessible. A 429 is returned when the request rate limit is exceeded. The thread_id path parameter must identify an accessible thread.