Speech-to-speech (EVI)Chat Groups

Get chat_group

Authentication

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

Path parameters

idstringRequiredformat: "uuid"
Identifier for a chat. Formatted as a UUID.

Query parameters

statusstringOptional
Chat status to apply to the chat. String from the ChatStatus enum.
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.

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.

ascending_orderbooleanOptional

Boolean to indicate if the results should be paginated in chronological order or reverse-chronological order. Defaults to true.

Response

Success
chats_pagelist of objects
List of chats and their metadata returned for the specified page number and page size.
first_start_timestamplong
The timestamp when the first chat in this chat group started, formatted as a Unix epoch milliseconds.
idstring

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

most_recent_start_timestamplong
The timestamp when the most recent chat in this chat group started, formatted as a Unix epoch milliseconds.
num_chatsinteger
The total number of chats in this chat group.
page_numberinteger
The page number of the returned results.
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.
activeboolean or null