List voices

Lists voices you have saved in your account, or voices from the Voice Library.

Headers

X-Hume-Api-KeystringRequired

Query parameters

providerenumRequired

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:
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_orderbooleanOptional

Response

Success

page_numberintegerOptional

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_sizeintegerOptional

The maximum number of items returned per page.

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

total_pagesintegerOptional

The total number of pages in the collection.

voices_pagelist of objectsOptional

List of voices returned for the specified page_number and page_size.

Errors