Text To Speech (Speak)

Get a stock voice

get/v1/voices/{id}

Request

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

Path parameters

idstring required

Canonical stock voice id or permanent alias. Alias lookups return the canonical voice_id.

Response

Stock voice

objectstring
voice_idstring
namestring
gender'M' | 'F'
regionstring

Accent / regional flavor.

agestring
tonestring
biostring
languagestring
avatar_urlstring uri

Voice-matched avatar image (PNG).

preview_urlstring uri

Optional pre-generated audio preview (MP3). If absent, synthesize a short sample with this voice_id.

accentstring

Normalized accent label used for matching.

age_bandstring

Normalized age band, e.g. 25-34.

pitch_bandstring

Normalized pitch band, e.g. low-medium.

pacestring

Normalized speaking pace.

use_casesstring[]

Recommended Agent and content use cases.

search_tagsstring[]

Search and auto-suggest tags.

aliasesstring[]

Permanent convenience identifiers accepted on the voice's advertised surfaces. API responses report the canonical voice_id.

available_onstring[]

Product surfaces on which this stock voice can be selected.

speak_emotionsstring[]

Verified named delivery controls on Speak for this voice. An empty or absent list means directed emotion is unavailable. These controls apply to streaming and buffered speech; intensity is not supported.

synthesis_modesstring[]

Delivery modes accepted for this voice on POST /v1/audio/speech. Every Speak-available voice accepts both; a voice served from a blocking-only fleet answers a streaming request with x-pyai-stream: buffered. An empty list means the voice has no Speak surface at all (check available_on).

tier'standard' | 'natural'

Customer-facing voice quality tier. The public catalog includes Standard and Natural voices; inspect available_on and synthesis_modes before use.

source_datasetstring

Source dataset attribution.

licensestring

Source voice license identifier.

Example response

{
  "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.