Get chat group audio

GET

Fetches a paginated list of audio for each Chat within the specified Chat Group. For more details, see our guide on audio reconstruction here.

Path parameters

idstringRequired

Identifier for a chat. Formatted as a UUID.

Query parameters

page_numberintegerOptional

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_orderbooleanOptionalDefaults to false

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

Response

Success

idstring

Identifier for the chat group. Formatted as a UUID.

user_idstring

Identifier for the user that owns this chat. Formatted as a UUID.

num_chatsinteger

Total number of chats in this chatgroup

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.

total_pagesinteger

The total number of pages in the collection.

pagination_direction"ASC" or "DESC"
Allowed values: ASCDESC

Indicates the order in which the paginated results are presented, based on their creation date.

It shows ASC for ascending order (chronological, with the oldest records first) or DESC for descending order (reverse-chronological, with the newest records first). This value corresponds to the ascending_order query parameter used in the request.

audio_reconstructions_pagelist of objects

List of chat audio reconstructions returned for the specified page number and page size.