> ## Documentation Index > Fetch the complete documentation index at: https://breezeblue-pre.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # List voices > List or search every voice available to the authenticated account. Search combines semantic relevance with exact and partial text matching. ## OpenAPI ````yaml /openapi.json get /v1/voices openapi: 3.1.0 info: title: Breeze Developer API description: >- Breeze Developer API for models, voices, text-to-speech, history, balance, usage, and browser-managed API keys. version: 1.0.0 servers: - url: https://api.breeze.blue security: [] tags: - name: Models description: Supported TTS models. - name: Text to Speech description: Text-to-speech synthesis and instruction enhancement. - name: Voices description: Saved voices and voice settings. - name: Voice Previews description: Create, audition, and save temporary voice previews. - name: Account description: Balance, usage, and API keys. - name: History description: Generated audio history. paths: /v1/voices: get: tags: - Voices summary: List voices description: >- List or search every voice available to the authenticated account. Search combines semantic relevance with exact and partial text matching. operationId: voices_list parameters: - name: search in: query required: false schema: anyOf: - type: string - type: 'null' title: Search description: >- Search public catalog voices by semantic and text relevance, and personal voices by name, description, or voice identifier. - name: language_code in: query required: false schema: anyOf: - type: string - type: 'null' title: Language Code enum: - ar - cs - de - el - en - es - fi - fr - hi - id - it - ja - ko - nl - pl - pt - ro - ru - th - tr - uk - vi - zh description: >- Only return voices whose saved audio language matches this supported ISO 639-1 two-letter language code. - name: origin in: query required: false schema: anyOf: - type: string - type: 'null' title: Origin description: 'Optional origin filter. Accepted values: designed, cloned.' - name: voice_type in: query required: false schema: type: string default: all title: Voice Type description: 'Voice source filter. Accepted values: all, default, personal.' - name: sort in: query required: false schema: type: string default: created_at_unix title: Sort description: 'Sort field. Accepted values: created_at_unix, name.' - name: sort_direction in: query required: false schema: type: string default: desc title: Sort Direction description: 'Sort direction. Accepted values: asc, desc.' - name: next_page_token in: query required: false schema: anyOf: - type: string - type: 'null' title: Next Page Token description: Cursor token returned by a previous response. - name: page in: query required: false schema: type: integer minimum: 1 default: 1 title: Page description: Page number for offset-based navigation. - name: page_size in: query required: false schema: type: integer maximum: 100 minimum: 1 default: 50 title: Page Size description: Number of records to return per page. - name: favorites_only in: query required: false schema: type: boolean default: false title: Favorites Only description: Only return voices favorited by the authenticated account. - name: tags in: query required: false schema: anyOf: - type: array items: type: string - type: 'null' title: Tags description: Repeat for exact full-value AND matching against effective tags. responses: '200': description: Paginated voice list. content: application/json: schema: $ref: '#/components/schemas/VoiceListResponse' headers: x-breeze-api-key-id: description: >- Public API key identifier used to authenticate the request, when an API key was used. schema: type: string '400': description: HTTP 400 error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '401': description: HTTP 401 error response. content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' '422': description: HTTP 422 error response. content: application/json: schema: $ref: '#/components/schemas/ValidationErrorResponse' security: - ApiKeyAuth: [] x-codeSamples: - lang: cURL label: cURL source: |- curl \ --request GET \ --url "https://api.breeze.blue/v1/voices" \ --header "xi-api-key: $BREEZE_API_KEY" - lang: Python label: Python SDK source: |- import os from breeze_blue import BreezeBlue client = BreezeBlue(api_key=os.environ["BREEZE_API_KEY"]) voices = client.voices.search(search="calm documentary narrator") for voice in voices["voices"]: print(voice["voice_id"], voice["name"]) - lang: TypeScript label: TypeScript SDK source: >- import { BreezeBlueClient } from "@breeze.blue/sdk"; const client = new BreezeBlueClient({ apiKey: process.env.BREEZE_API_KEY!, }); const voices = await client.voices.search({ search: "calm documentary narrator" }); for (const voice of voices.voices) { console.log(voice.voiceId, voice.name); } components: schemas: VoiceListResponse: properties: voices: items: $ref: '#/components/schemas/VoiceResponse' title: Voices type: array has_more: title: Has More type: boolean next_page_token: anyOf: - type: string - type: 'null' default: null title: Next Page Token total: title: Total type: integer page: title: Page type: integer page_size: title: Page Size type: integer required: - voices - has_more - total - page - page_size title: VoiceListResponse type: object ErrorResponse: properties: ok: default: false title: Ok type: boolean code: title: Code type: string detail: title: Detail type: string error: title: Error type: string meta: anyOf: - additionalProperties: true type: object - type: 'null' default: null title: Meta required: - code - detail - error title: ErrorResponse type: object ValidationErrorResponse: properties: ok: default: false title: Ok type: boolean code: title: Code type: string detail: title: Detail type: string error: title: Error type: string meta: anyOf: - additionalProperties: true type: object - type: 'null' title: Meta required: - code - detail - error title: ValidationErrorResponse type: object VoiceResponse: additionalProperties: true properties: voice_id: title: Voice Id type: string name: title: Name type: string origin: title: Origin type: string voice_type: title: Voice Type type: string tags: items: type: string maxLength: 128 maxItems: 20 title: Tags type: array is_favorited: default: false title: Is Favorited type: boolean preview_url: anyOf: - type: string - type: 'null' default: null title: Preview Url settings: $ref: '#/components/schemas/VoiceSettingsResponse' description: anyOf: - type: string - type: 'null' default: null title: Description language_code: enum: - ar - cs - de - el - en - es - fi - fr - hi - id - it - ja - ko - nl - pl - pt - ro - ru - th - tr - uk - vi - zh title: Language Code type: string gender: anyOf: - type: string enum: - male - female - neutral - type: 'null' title: Gender age: anyOf: - type: string enum: - child - young - middle_aged - old - type: 'null' title: Age tone: items: type: string enum: - warm - calm - bright - gentle - energetic - authoritative - sincere - weary - precise - refined - urgent - friendly - articulate - steady - playful - compassionate - reflective - measured - rhythmic - passionate maxItems: 3 title: Tone type: array uniqueItems: true accent: anyOf: - type: string enum: - american - british - scottish - irish - australian - canadian - us_southern - us_new_york - indian - south_african - russian - japanese - korean - chinese - mandarin_guangdong - mandarin_northeastern - mandarin_shaanxi - mandarin_shanghai - mandarin_sichuan - mandarin_yunnan - mandarin_henan - cantonese - type: 'null' title: Accent created_at_unix: anyOf: - type: integer - type: 'null' default: null title: Created At Unix required: - voice_id - name - origin - voice_type - settings - language_code - gender - age - tone - accent title: VoiceResponse type: object VoiceSettingsResponse: properties: guidance_scale: default: 1 title: Guidance Scale type: number title: VoiceSettingsResponse type: object securitySchemes: ApiKeyAuth: type: apiKey in: header name: xi-api-key description: Breeze Developer API key. ````