Skip to main content
GET
/
v1
/
voices
cURL
curl \
  --request GET \
  --url "https://api.breeze.blue/v1/voices" \
  --header "xi-api-key: $BREEZE_API_KEY"
{
  "voices": [
    {
      "voice_id": "<string>",
      "name": "<string>",
      "category": "<string>",
      "voice_type": "<string>",
      "settings": {
        "guidance_scale": 1
      },
      "labels": {},
      "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

Filter voices by name or description.

​
category
string | null

Optional category filter. Accepted values: premade, generated, 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

Response

Paginated voice list.

​
voices
VoiceResponse · object[]
required
​
has_more
boolean
required
​
total
integer
required
​
page
integer
required
​
page_size
integer
required
​
next_page_token
string | null