List voices | Hume API

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

Lists voices you have saved in your account, or voices from the [Voice Library](https://app.hume.ai/tts/voice-library).

Authentication

X-Hume-Api-Keystring

API Key authentication via header

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.

Specify the voice provider to filter voices returned by the endpoint: - **`HUME_AI`**: Lists preset, shared voices from Hume's [Voice Library](https://app.hume.ai/tts/voice-library). - **`CUSTOM_VOICE`**: Lists custom voices created and saved to your account.

Allowed values:

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

filter_taglist of stringsOptional

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.

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_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.

voices_pagelist of objects

List of voices returned for the specified page_number and page_size.

1	{
2	"page_number": 0,
3	"page_size": 10,
4	"total_pages": 1,
5	"voices_page": [
6	{
7	"id": "c42352c0-4566-455d-b180-0f654b65b525",
8	"name": "David Hume",
9	"provider": "CUSTOM_VOICE"
10	},
11	{
12	"id": "d87352b0-26a3-4b11-081b-d157a5674d19",
13	"name": "Goliath Hume",
14	"provider": "CUSTOM_VOICE"
15	}
16	]
17	}