List voices

List or search every voice available to the authenticated account. Search combines semantic relevance with exact and partial text matching.

GET /v1/voices

cURL

cURL

curl \
  --request GET \
  --url "https://api.breeze.blue/v1/voices" \
  --header "xi-api-key: $BREEZE_API_KEY"

200

{
  "voices": [
    {
      "voice_id": "<string>",
      "name": "<string>",
      "origin": "<string>",
      "voice_type": "<string>",
      "settings": {
        "guidance_scale": 1
      },
      "language_code": "ar",
      "gender": "male",
      "age": "child",
      "tone": [
        "warm"
      ],
      "accent": "american",
      "tags": [
        "<string>"
      ],
      "is_favorited": false,
      "preview_url": "<string>",
      "description": "<string>",
      "created_at_unix": 123
    }
  ],
  "has_more": true,
  "total": 123,
  "page": 123,
  "page_size": 123,
  "next_page_token": "<string>"
}

Authorizations

xi-api-key · string · header · required

Breeze Developer API key.

Query Parameters

search · string | null

Search public catalog voices by semantic and text relevance, and personal voices by name, description, or voice identifier.

language_code · enum<string>

Only return voices whose saved audio language matches this supported ISO 639-1 two-letter language code.

Available options: ar, cs, de, el, en, es, fi, fr, hi, id, it, ja, ko, nl, pl, pt, ro, ru, th, tr, uk, vi, zh

origin · string | null

Optional origin filter. Accepted values: designed, cloned.

voice_type · string · default: all

Voice source filter. Accepted values: all, default, personal.

sort · string · default: created_at_unix

Sort field. Accepted values: created_at_unix, name.

sort_direction · string · default: desc

Sort direction. Accepted values: asc, desc.

next_page_token · string | null

Cursor token returned by a previous response.

page · integer · default: 1

Page number for offset-based navigation.

Required range: x >= 1

page_size · integer · default: 50

Number of records to return per page.

Required range: 1 <= x <= 100

favorites_only · boolean · default: false

Only return voices favorited by the authenticated account.

tags · string[] | null

Repeat for exact full-value AND matching against effective tags.

Response

200

application/json

Paginated voice list.

voices · VoiceResponse · object[] · required

Show child attributes

has_more · boolean · required

total · integer · required

page · integer · required

page_size · integer · required

next_page_token · string | null