Skip to main content
POST
Create speech from text using a catalog or owned custom voice. Uses the same character credits and plan limits as the app. Returns a history ID and a temporary audio download URL. Reuse requestId to avoid a second generation.

Authentication and permissions

string
required
Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by MCP, not by this REST endpoint.
Required permissions: tts:write. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

Parameters

string
Optional at the transport boundary: the server injects an identifier before validation when omitted. Supply your own stable UUID v4 to recover safely from a lost response.Format: “uuid”. Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$.
string
required
Text value.Minimum length: 1. Maximum length: 128000.
string
required
A voice selection ID from voices_list, including clone: IDs for saved custom voices.Minimum length: 1. Maximum length: 255.
string
Text value.Allowed values: “text”, “pdf”. Default: “text”.
string
Text value.Allowed values: “default”, “cheerful”, “calm”, “narrator”, “dramatic”, “whisper”, “energetic”. Default: “default”.
string
Text value.Maximum length: 300.
number
Numeric value.Minimum: 0.5. Maximum: 2. Default: 1.
string
Text value.Maximum length: 255.
The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

Idempotency

Use a UUID v4 in requestId or the Idempotency-Key HTTP header for each mutation. Reuse the same identifier and identical arguments after a network failure. If both are supplied, they must match. Replaying a saved request does not repeat the operation or charge another monthly call. Failed or interrupted requests are not restarted automatically. Every mutation can return HTTP 202 when a retry finds the same request still running, even when its first execution is normally synchronous. If execution completed but resultStored is false, a retry returns HTTP 200 with saved request state instead of the original result. Retrieve the output through its domain history, result, or download action.

Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

Response

This operation returns HTTP 202 while running. Save requestId and poll action_request_get with that identifier and the original operation name. Polling states are running, completed, failed, and interrupted. A completed result can point to a separate media job; continue with the operation-specific status or output action. Completed speech generation metadata and a temporary MP3 download URL. The handler does not return audio bytes.

Result fields

Recover and poll this request

Use the same identifier even after a lost connection. If resultStored is false, retrieve the output through the corresponding history, result, or download action. Never start a second generation merely to check progress.
HTTP 200

Operation notes

  • Use a UUID v4 requestId for this mutation and reuse it with identical arguments when retrying. Long-running actions first return a running request; this example is the completed handler result available from action_request_get.
  • Choose voice from voices_list. Dubbing voice IDs from dubbing_voices_list are a separate library.
  • Text is trimmed. The schema accepts at most 128,000 characters; current Beginner and Starter plans allow 64,000 per generation, while Creator and higher plans allow 128,000. The current plan and available TTS character credits are checked again before generation.
  • inputType defaults to text and can be text or pdf. Even with pdf, supply extracted text in text; this action does not accept a PDF upload or URL.
  • instructionPreset defaults to default and supports default, cheerful, calm, narrator, dramatic, whisper, and energetic. instructions is optional and limited to 300 trimmed characters. speed defaults to 1 and ranges from 0.5 to 2.
  • sourceFileName is optional metadata, limited to 255 trimmed characters, and determines the download filename.
  • A successful repeated request replays saved audio without generating or charging for it again. URLs are temporary; use tts_download for a fresh download.
  • Speech history and custom voices belong to the authenticated account. Team billing does not grant access to another member’s speech or voices.

Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation’s own generation allowances also apply.

Errors