List voices | Hume API

Authentication

X-Hume-Api-Keystring

API Key authentication via header

Query parameters

providerenum (Required)
Specify the voice provider to filter voices returned by the endpoint:

• HUME_AI: Lists preset, shared voices from Hume’s Voice Library.
• CUSTOM_VOICE: Lists custom voices created and saved to your account.

Allowed values: HUME_AI, CUSTOM_VOICE

page_number integer (Optional)
Defaults 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_size integer (Optional)
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_order boolean (Optional)

filter_tag list of strings (Optional)
Filter voices by tag using TAG:TAG_VALUE syntax.

For example, GENDER:Male returns only voices with the GENDER tag set to Male. Tag types are case-insensitive; tag values are case-sensitive.

Multiple values are ANDed together; for example, [GENDER:Male, LANGUAGE:Japanese] returns only voices matching both criteria.

Response

Success

page_number integer
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_size integer
The maximum number of items returned per page.

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

total_pages integer
The total number of pages in the collection.

voices_page list of objects
List of voices returned for the specified page_number and page_size.