Skip to main content
Version: 2.0

List Chats API Definition

The List Chats API allows you to retrieve a list of previous chats in your account. This endpoint returns a paginated list of chat objects, which contain basic information about each chat.

List Chats Request and Response​

To list chats, send a GET request to /v2/chats. You can specify optional query parameters to control the pagination of the results.

  • limit - Specifies the maximum number of chats to return in a single request, with a default value of 10 and a maximum value of 100.
  • page_key - Retrieves the next page of results when the previous request has reached the limit.

The response contains an array of chat objects with matching chats and metadata about the pagination.

REST 2.0 URL​

List Chats Endpoint Address​

Vectara exposes an HTTP endpoint at the following URL to list chats:
https://api.vectara.io/v2/chats

The API Reference shows the full List Chats REST definition.