List chats

GET 
/v2/chats

Retrieve a list of previous chats in the Vectara account.

Request

Query Parameters

limit int32

Possible values: >= 1 and <= 10000

Default value: 1000

The maximum number of results to return in the list.

page_key string

Used to retrieve the next page of chats after the limit has been reached.

Header Parameters

Request-Timeout integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified seconds or time out.

Request-Timeout-Millis integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified milliseconds or time out.

Responses

200

List of chats.

application/json

Schema

Schema

chats object[]
List of chats.
Array [
id string
Possible values: Value must match regular expression cht_.+$
ID of the chat.
first_query string
The first query of the chat.
first_answer string
The first answer of the chat.
enabled boolean
Indicates whether this chat is enabled and can have further turns.
created_at date-time
Specifies when this chat was created.
]
metadata object

The standard metadata in the response of a list operation.

page_key string

When requesting the next page of this list, this is needed as a query parameter.

Example (from schema)

{
  "chats": [
    {
      "id": "string",
      "first_query": "string",
      "first_answer": "string",
      "enabled": true,
      "created_at": "2024-12-13T17:52:53.622Z"
    }
  ],
  "metadata": {
    "page_key": "string"
  }
}

403

Permissions do not allow listing chats.

application/json

Schema

Schema

messages message[]

The messages describing why the error occurred.

request_id string

The ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "messages": [
    "Internal server error."
  ],
  "request_id": "string"
}

404

Corpus not found.

application/json

Schema

Schema

id string

The ID cannot be found.

messages message[]
request_id string

ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "id": "string",
  "messages": [
    "string"
  ],
  "request_id": "string"
}

Loading...