Speech-to-speech (EVI)Chats

List chats

Fetches a paginated list of Chats.

Authentication

X-Hume-Api-Keystring
API Key authentication via header

Query parameters

page_numberintegerOptionalDefaults to 0
Specifies the page number to retrieve, enabling pagination. This parameter uses zero-based indexing. For example, setting `page_number` to 0 retrieves the first page of results (items 0-9 if `page_size` is 10), setting `page_number` to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
page_sizeintegerOptional

Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.

For example, if page_size is set to 10, each page will include up to 10 items. Defaults to 10.

ascending_orderbooleanOptional

Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.

config_idstringOptionalformat: "uuid"
Filter to only include chats that used this config.
statusstringOptional
Chat status to apply to the chat. String from the ChatStatus enum.

Response

Success
chats_pagelist of objects

List of Chats and their metadata returned for the specified page_number and page_size.

chat_group_idstring

Identifier for the Chat Group. Any chat resumed from this Chat will have the same chat_group_id. Formatted as a UUID.

idstring
Identifier for a Chat. Formatted as a UUID.
start_timestamplong
Time at which the Chat started. Measured in seconds since the Unix epoch.
statusenum
configobjectOptional
The Config associated with this Chat.
end_timestamplong or nullOptional
Time at which the Chat ended. Measured in seconds since the Unix epoch.
event_countlong or nullOptional
The total number of events currently in this chat.
metadatastring or nullOptional
Stringified JSON with additional metadata about the chat.
page_numberinteger

The page number of the returned list.

This value corresponds to the page_number parameter specified in the request. Pagination uses zero-based indexing.

page_sizeinteger

The maximum number of items returned per page.

This value corresponds to the page_size parameter specified in the request.

pagination_directionenum
Allowed values:
total_pagesinteger
The total number of pages in the collection.