Text To Speech (Speak)

List voices

Your unified voice library: the prebuilt PyAI catalog (with presentation metadata; some entries include an avatar or pre-generated audio preview) merged with your saved designed voices, each tagged by source (stock | design). Any active key may read it (no specific scope). Inspect available_on before using a stock voice with Speak or Omni, and inspect synthesis_modes before choosing streaming or async Speak delivery. tier is the customer-facing quality tier. pricing reports only the voice-specific amount on top of that product's base rate. aliases are permanent convenience inputs on the advertised surfaces; responses report the canonical voice_id. Cloned voices are listed separately via GET /v1/voice/clones.

get/v1/voices

Request

  • Base URL: https://api.pyai.com
  • URL: https://api.pyai.com/v1/voices
  • Auth: one of:
    • HTTP bearer
    • API key in header x-api-key

Query parameters

gender'M' | 'F' | 'm' | 'f' | 'male' | 'female'

Filter stock voices by gender (case-insensitive; M/male or F/female).

regionstring

Filter stock voices by region/accent (case-insensitive substring match, e.g. us, india, scotland) or locale (e.g. en_us, en-US, en_gb). Locale filters match language and accent metadata.

language'bn' | 'de' | 'en' | 'en-CA' | 'en-GB' | 'en-US' | 'en-ZA' | 'es' | 'fr' | 'gu' | 'hi' | 'it' | 'ja' | 'kn' | 'ko' | 'pa' | 'pt' | 'ru' | 'te' | 'ur' | 'zh'

Filter stock voices by stable language code from the customer catalog. Inspect available_on for each voice’s supported products.

tier'standard' | 'natural'

Filter stock voices by customer-facing quality tier.

qstring

Rank stock voices by matching tokens across name, aliases, accent, language, age band, pitch, tone, use cases, and search tags.

source'stock' | 'design'

Return only one kind of voice. Omit for the merged library.

Response

Voice library (stock + designed)

objectstring

Example response

{
  "object": "list",
  "data": [
    {
      "object": "voice",
      "voice_id": "stock_dorit_en_us",
      "name": "Imogen",
      "region": "UK (England / RP)",
      "age": "32",
      "tone": "polished, reassuring",
      "bio": "Calm, articulate London front-desk.",
      "language": "en",
      "tier": "standard",
      "pricing": {
        "included_in_base_price": true
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.