Preview a voice
preview_voiceRender one bounded, rate-limited voice preview for the authenticated workspace. A text-to-speech voice speaks the caller's text (at most 200 characters); a conversation-engine voice (GPT-Live-1, Gemini Live, Eleven Realtime) plays Skysay's fixed sample and refuses typed text. This may contact a managed provider or validate BYOK and can write preview-rate and exact voice-availability state; it is not a read-only or free preview. Returned audio is bounded in-memory WAV data.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | No | Optional bounded caller sentence for a text-to-speech voice. It is synthesized but not persisted or echoed. A conversation-engine voice refuses it (voice_preview_fixed_sample) and plays Skysay's fixed sample. | |
| model | Yes | ||
| agent_id | No | Optional saved hosted agent id for an exact pinned managed voice retry. | |
| delivery | No | Optional delivery profile; the preview applies exactly the provider settings a call with the same voice_polish.delivery would use. | |
| language | Yes | ||
| provider | Yes | ||
| voice_id | Yes | ||
| project_id | Yes | ||
| credential_id | No | Optional customer-owned TTS credential id; the platform credential is never a fallback. | |
| organization_id | No | Optional. Defaults to the authenticated workspace; when supplied it must be that workspace's id. | |
| audio_environment | No | Optional selected ambience mixed only into this preview. For a text-to-speech voice, text must then be non-blank and explicit; a conversation-engine voice needs no text and the ambience is mixed over its fixed sample. The language and text are never replaced. |