Sign in

Retrieve a ChatKit thread

Retrieve a ChatKit thread by its identifier.

get/chatkit/threads/{thread_id}

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

Changed in 2 of the 164 revisions of this API.4

  • d86203de41ae3See the full diff
    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

    • ○

      added the non-success response with the status

      response-non-success-status-added

  • 74cbcf73838f1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 40 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog