Preview Voice
Render a short sample of voice_id at the telephony sample rate.
8 kHz, not studio quality — the pipeline renders straight to 8 kHz for the 3CX stream, and band-limiting is exactly where voices stop sounding alike.
Request
- Base URLhttps://dev.whispa.net (the document declares no server; this is the origin it was published from)
- Auth
- OAuth 2PasswordToken URL: auth/bearer/login
- or API key in cookie access_token
Path parameters
Query parameters
ai_agent scenario whose opening line the preview should speak — the truest audition, since it is the exact wording that scenario greets with, placeholders rendered as a real dial renders them. Falls back to the generic sample if it cannot be resolved.
Explicit line to speak instead of the scenario's greeting — a candidate opening line. Still a $placeholder template: combined with scenario it renders against that scenario's brand context, so a draft opener auditions as a dial would speak it. Truncated to 400 characters — a longer line is still auditioned, just not to the end.
Cartesia model to audition. Omit to use the scenario's configured model, then the runtime default.
Response
8 kHz mono WAV — the telephony band the caller hears.
Changes
No recorded changes to this operation across all 1 revision of this API.