Preview a voice
preview_voiceRender one bounded, rate-limited provider-backed TTS preview for the authenticated workspace. 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. Caller text is at most 200 characters and returned audio is bounded in-memory WAV data.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| text | No | Optional bounded caller sentence. It is synthesized but not persisted or echoed. | |
| 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. When present, text must be non-blank and explicit; the language and text are never replaced. |