> ## 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 Voice Metadata options

> Return the stable code sets accepted by Voice Metadata fields, including the complete language_code enum, the tone limit, and the language-to-accent cascade. Values are stable codes rather than localized display text.



## OpenAPI

````yaml /openapi.json get /v1/voice-metadata/options
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/voice-metadata/options:
    get:
      tags:
        - Voices
      summary: List Voice Metadata options
      description: >-
        Return the stable code sets accepted by Voice Metadata fields, including
        the complete language_code enum, the tone limit, and the
        language-to-accent cascade. Values are stable codes rather than
        localized display text.
      operationId: voice_metadata_options
      responses:
        '200':
          description: Voice Metadata code options and constraints.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VoiceMetadataOptionsResponse'
          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
        '401':
          description: HTTP 401 error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
      security:
        - ApiKeyAuth: []
      x-codeSamples:
        - lang: cURL
          label: cURL
          source: |-
            curl \
              --request GET \
              --url "https://api.breeze.blue/v1/voice-metadata/options" \
              --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"])

            options = client.voices.metadata_options()
            print(options["language_codes"])
            print(options["accent_codes_by_language"]["en"])
        - lang: TypeScript
          label: TypeScript SDK
          source: |-
            import { BreezeBlueClient } from "@breeze.blue/sdk";

            const client = new BreezeBlueClient({
              apiKey: process.env.BREEZE_API_KEY!,
            });

            const options = await client.voices.metadataOptions();
            console.log(options.languageCodes);
            console.log(options.accentCodesByLanguage.en);
components:
  schemas:
    VoiceMetadataOptionsResponse:
      properties:
        language_codes:
          description: Supported language_code values in canonical order.
          items:
            type: string
            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 Codes
          type: array
        gender_codes:
          items:
            type: string
            enum:
              - male
              - female
              - neutral
          title: Gender Codes
          type: array
        age_codes:
          items:
            type: string
            enum:
              - child
              - young
              - middle_aged
              - old
          title: Age Codes
          type: array
        tone_codes:
          items:
            type: string
            enum:
              - warm
              - calm
              - bright
              - gentle
              - energetic
              - authoritative
              - sincere
              - weary
              - precise
              - refined
              - urgent
              - friendly
              - articulate
              - steady
              - playful
              - compassionate
              - reflective
              - measured
              - rhythmic
              - passionate
          title: Tone Codes
          type: array
        tone_max_items:
          description: Maximum number of distinct tone codes accepted for one voice.
          examples:
            - 3
          title: Tone Max Items
          type: integer
        accent_codes_by_language:
          additionalProperties:
            items:
              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: array
          description: >-
            Accent codes keyed by every supported language_code. Languages
            without accent choices have an empty array.
          title: Accent Codes By Language
          type: object
      required:
        - language_codes
        - gender_codes
        - age_codes
        - tone_codes
        - tone_max_items
        - accent_codes_by_language
      title: VoiceMetadataOptionsResponse
      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
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: xi-api-key
      description: Breeze Developer API key.

````