Skip to main content
POST
Create voice candidates from a description using your voice design allowance. Listen with voices_preview_get, then save your chosen preview.

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: voices: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: 80.
string
required
Text value.Minimum length: 1. Maximum length: 2000.
string
Text value.Maximum length: 35. Pattern: ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.
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. All active unsaved previews and updated creation allowances, including two new designed voice candidates.

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.
  • name contains 1–80 trimmed characters. description contains 1–2,000 trimmed characters. Optional language accepts a 2–3 letter code with optional subtags and a maximum of 35 characters.
  • A successful design request creates two kind: design candidates with numbered names and consumes one daily design request. Paid plans allow five requests per UTC day; inspect creationUsage.design for the current count and reset time.
  • Candidates last 24 hours and are not saved reusable TTS voices. Listen with voices_preview_get, then save a selected candidate with voices_save_preview.
  • The response includes earlier active previews as well as the new candidates. No saved voice slot is occupied until a candidate is saved.
  • 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