Get chat group audio

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

Authentication

X-Hume-Api-Keystring

API Key authentication via header

Path parameters

idstringRequiredformat: "uuid"

Identifier for a Chat Group. Formatted as a UUID.

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.

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.

Response

Success

audio_reconstructions_pagelist of objects

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

idstring

Identifier for the chat. Formatted as a UUID.

statusenum

Allowed values:

user_idstring

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

filenamestring or nullOptional

Name of the chat audio reconstruction file.

modified_atlong or nullOptional

The timestamp of the most recent status change for this audio reconstruction, formatted milliseconds since the Unix epoch.

signed_audio_urlstring or nullOptional

Signed URL used to download the chat audio reconstruction file.

signed_url_expiration_timestamp_millislong or nullOptional

The timestamp when the signed URL will expire, formatted as a Unix epoch milliseconds.

idstring

Identifier for the chat group. 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.

pagination_directionenum

Allowed values:

total_pagesinteger

The total number of pages in the collection.

user_idstring

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