Skip to main content
POST
Get metadata and a playable example for one catalog or owned custom dubbing voice.

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:read. An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

Parameters

string
required
Text value.Minimum length: 1. Maximum length: 255. Pattern: ^[A-Za-z0-9_-]+$.
string
Text value.Allowed values: “en”, “fr”, “es”, “de”, “it”, “pt”, “pl”, “zh”, “ja”. Default: “en”.
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.

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

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field. One catalog or owned custom dubbing voice with its public metadata and optional playable example.

Result fields

Operation notes

  • Use voiceId from dubbing_voices_list. It is an opaque 1–255 character ID containing only letters, digits, underscores, and hyphens.
  • locale has the same defaults and accepted values as dubbing_voices_list. Catalog voices can include localized language, accent, description, age, gender, useCase, and category metadata.
  • Owned custom voices return source: custom and optional previewUrl; they omit the catalog language fields. A raw clone response’s audioExampleUrl is represented as previewUrl here.
  • 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