curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_clone' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"33333333-3333-4333-8333-333333333333","name":"Studio narrator","samples":[{"fileKey":"uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}],"hasPermission":true,"trimToMaxDuration":false}'
const input = {
requestId: '33333333-3333-4333-8333-333333333333',
name: 'Studio narrator',
samples: [
{
fileKey: 'uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav',
},
],
hasPermission: true,
trimToMaxDuration: false,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_clone', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/voices_clone",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "33333333-3333-4333-8333-333333333333", "name": "Studio narrator", "samples": [{"fileKey": "uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}], "hasPermission": True, "trimToMaxDuration": False},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"data": {
"voice": {
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
}
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
Spraakstemmen
Een stem klonen en opslaan
Kloon een aangepaste stem op basis van 1–3 audio-uploads waarvan je eigenaar bent en sla deze op. Uitdrukkelijke toestemming is vereist. De fragmenten moeten samen 10–120 seconden duren en elk maximaal 20 MB groot zijn. De stemlimieten van het abonnement zijn van toepassing.
POST
/
v1
/
actions
/
voices_clone
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_clone' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"33333333-3333-4333-8333-333333333333","name":"Studio narrator","samples":[{"fileKey":"uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}],"hasPermission":true,"trimToMaxDuration":false}'
const input = {
requestId: '33333333-3333-4333-8333-333333333333',
name: 'Studio narrator',
samples: [
{
fileKey: 'uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav',
},
],
hasPermission: true,
trimToMaxDuration: false,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_clone', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/voices_clone",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "33333333-3333-4333-8333-333333333333", "name": "Studio narrator", "samples": [{"fileKey": "uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}], "hasPermission": True, "trimToMaxDuration": False},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"data": {
"voice": {
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
}
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
Kloon een aangepaste stem op basis van 1–3 audio-uploads waarvan je eigenaar bent en sla deze op. Uitdrukkelijke toestemming is vereist. De fragmenten moeten samen 10–120 seconden duren en elk maximaal 20 MB groot zijn. De stemlimieten van het abonnement zijn van toepassing.
Vereiste machtigingen:
POST https://api.voicecheap.ai/v1/actions/voices_clone
Authenticatie en machtigingen
string
vereist
Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens
worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
voices:write.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
Parameters
string
Optioneel op transportniveau: als de identificatie ontbreekt, voegt de server deze vóór de validatie toe. Geef zelf een stabiele UUID v4 op om veilig te kunnen herstellen als een antwoord verloren gaat.Formaat: “uuid”. Patroon:
^[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
vereist
Tekstwaarde.Minimale lengte: 1. Maximale lengte: 80.
array
vereist
Lijst met waarden. Zie het volledige invoerschema voor de structuur van de items.Minimaal aantal items: 1. Maximaal aantal items: 3.
boolean
vereist
Bevestig dat je toestemming hebt om de persoon te klonen van wie de stem in elk fragment te horen is.Vereiste waarde: true.
boolean
Booleaanse waarde.Standaardwaarde: false.
string
Tekstwaarde.Maximale lengte: 35. Patroon:
^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$.Volledig invoerschema
Volledig invoerschema
Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.
{
"type": "object",
"properties": {
"requestId": {
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
"type": "string",
"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}$"
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 80
},
"samples": {
"minItems": 1,
"maxItems": 3,
"type": "array",
"items": {
"type": "object",
"properties": {
"fileKey": {
"type": "string",
"minLength": 1,
"maxLength": 1024,
"description": "An uploaded audio fileKey returned by voices_upload_complete for this account."
}
},
"required": ["fileKey"],
"additionalProperties": false
}
},
"hasPermission": {
"type": "boolean",
"const": true,
"description": "Confirm that you have permission to clone the person whose voice is in every sample."
},
"trimToMaxDuration": {
"default": false,
"type": "boolean"
},
"language": {
"type": "string",
"maxLength": 35,
"pattern": "^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$"
}
},
"required": ["name", "samples", "hasPermission"],
"additionalProperties": false
}
Idempotentie
Gebruik voor elke wijziging een UUID v4 in requestId of de HTTP-header Idempotency-Key. Gebruik na een netwerkfout dezelfde identificatie en identieke argumenten opnieuw. Als je beide opgeeft, moeten ze overeenkomen. Het opnieuw versturen van een opgeslagen aanvraag herhaalt de bewerking niet en verbruikt geen extra maandelijkse aanroep. Mislukte of onderbroken aanvragen worden niet automatisch opnieuw gestart. Elke wijziging kan HTTP 202 retourneren wanneer een nieuwe poging vaststelt dat dezelfde aanvraag nog loopt, ook wanneer de eerste uitvoering normaal synchroon is. Als de uitvoering is voltooid maar resultStored false is, retourneert een nieuwe poging HTTP 200 met de opgeslagen aanvraagstatus in plaats van het oorspronkelijke resultaat. Haal de uitvoer op via de geschiedenis-, resultaat- of downloadactie van het betreffende domein.Voorbeeldaanvragen
Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_clone' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"33333333-3333-4333-8333-333333333333","name":"Studio narrator","samples":[{"fileKey":"uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}],"hasPermission":true,"trimToMaxDuration":false}'
const input = {
requestId: '33333333-3333-4333-8333-333333333333',
name: 'Studio narrator',
samples: [
{
fileKey: 'uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav',
},
],
hasPermission: true,
trimToMaxDuration: false,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_clone', {
method: 'POST',
headers: {
'x-api-key': process.env.VOICECHEAP_API_KEY,
'Content-Type': 'application/json',
},
body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/voices_clone",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "33333333-3333-4333-8333-333333333333", "name": "Studio narrator", "samples": [{"fileKey": "uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}], "hasPermission": True, "trimToMaxDuration": False},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Antwoord
Deze bewerking retourneert HTTP 202 zolang deze wordt uitgevoerd. Bewaar requestId en controleer action_request_get met die identificatie en de oorspronkelijke bewerkingsnaam. De mogelijke statussen zijn running, completed, failed en interrupted. Een voltooid resultaat kan naar een afzonderlijke mediataak verwijzen; ga dan verder met de status- of uitvoeractie van die bewerking. De opgeslagen herbruikbare aangepaste TTS-stem en de bijgewerkte limiet voor opslagplaatsen.{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"data": {
"voice": {
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
}
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "33333333-3333-4333-8333-333333333333"
}
Resultaatvelden
| Veld | Beschrijving |
|---|---|
data.voice.id | Herbruikbare TTS-selectie-ID clone:<UUID>. Gebruik de volledige waarde voor tts_generate en alleen de UUID voor voices_delete. |
data.voice.name | Weergavenaam van de opgeslagen stem. |
data.voice.accent | Opgeslagen aangepaste stemmen gebruiken original. |
data.voice.source | Opgeslagen aangepaste stemmen gebruiken clone. |
data.voice.previewUrl | Tijdelijke URL voor een audiopreview van de opgeslagen stem. |
data.cloneUsage.canClone | Of het huidige abonnement opgeslagen aangepaste TTS-stemmen toestaat; controleer remaining voor beschikbare plaatsen. |
data.cloneUsage.limit | Abonnementsgrens voor het aantal plaatsen voor opgeslagen aangepaste TTS-stemmen. |
data.cloneUsage.used | Bezette plaatsen voor TTS-stemmen, inclusief gereserveerde aanmaakacties. |
data.cloneUsage.remaining | Beschikbare opslagplaatsen voor TTS-stemmen. |
Deze aanvraag herstellen en controleren
Gebruik dezelfde identificatie, ook nadat de verbinding is verbroken. Als resultStored false is, haal je de uitvoer op via de bijbehorende geschiedenis-, resultaat- of downloadactie. Start nooit een tweede generatie alleen om de voortgang te controleren.curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"33333333-3333-4333-8333-333333333333","operation":"voices_clone"}'
HTTP 200
{
"data": {
"requestId": "33333333-3333-4333-8333-333333333333",
"operation": "voices_clone",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"voice": {
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
}
}
}
}
Opmerkingen bij de bewerking
- Gebruik een UUID v4 requestId voor deze mutatie en hergebruik deze met identieke argumenten bij nieuwe pogingen. Langdurige acties retourneren eerst een aanvraag met status running; dit voorbeeld is het voltooide handlerresultaat dat beschikbaar is via action_request_get.
- Upload 1–3 eigen audiovoorbeelden en gebruik de voltooide fileKey-waarden ervan. Ondersteunde voorbeeldformaten zijn MP3, WAV, M4A, OGG en Opus; elk bestand moet niet-leeg zijn en maximaal 20 MiB (20,971,520 bytes) groot zijn. Externe URL’s en uploads van andere accounts worden geweigerd.
- De voorbeelden moeten in totaal minimaal 10 seconden en maximaal 120 seconden bruikbare audio bevatten. trimToMaxDuration is standaard false; stel deze in op true om voorbeelden met een totale duur van meer dan 120 seconden evenredig in te korten.
- hasPermission moet de JSON-boolean true zijn, waarmee toestemming voor elk fragment wordt bevestigd. Een stringwaarde zoals “true” wordt geweigerd.
- name moet na het verwijderen van witruimte aan het begin en einde 1–80 tekens bevatten. Het optionele language accepteert een code van 2–3 letters met optionele subtags en maximaal 35 tekens.
- Deze actie slaat de gekloonde stem direct op en neemt een plek voor een opgeslagen TTS-stem in. De eenmalige proef voor een kloonvoorbeeld wordt niet verbruikt.
- Gebruik de geretourneerde voice.id in tts_generate. Voor een directe kloon is de bijbehorende UUID de requestId; voices_delete gebruikt die UUID zonder het voorvoegsel clone:.
- Het geaccepteerde veld language verandert de kloonworkflow voor direct opslaan niet. Kies voices_preview_clone wanneer je een taalspecifiek voorbeeldscript nodig hebt.
- Spraakgeschiedenis en aangepaste stemmen behoren toe aan het aangemelde account. Facturering via een team geeft geen toegang tot de spraak of stemmen van een ander lid.
Verbruik
Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.Fouten
| HTTP-status | Code | Betekenis of herstel |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | Inloggegevens zijn opgegeven in een queryparameter access_token of api_key. Stuur inloggegevens in headers. |
| 400 | IDEMPOTENCY_CONFLICT | De header Idempotency-Key en het bodyveld requestId moeten overeenkomen. |
| 400 | INVALID_REQUEST_ID | Geef een UUID v4 op als requestId of Idempotency-Key. |
| 400 | VALIDATION_ERROR | De invoer komt niet overeen met het actieschema; controleer details op veldfouten. |
| 400 | VOICE_CLONE_INVALID_AUDIO | Een geüpload fragment heeft geen leesbare positieve audioduur. |
| 400 | VOICE_CLONE_INVALID_FILE_SIZE | Een opgeslagen sample is leeg of overschrijdt 20 MiB. |
| 400 | VOICE_CLONE_INVALID_FILE_TYPE | Een voorbeeld is geen MP3-, WAV-, M4A-, OGG- of Opus-audio. |
| 400 | VOICE_CLONE_SAMPLE_TOO_LONG | De gecombineerde samples overschrijden 120 seconden en inkorten is niet ingeschakeld. |
| 400 | VOICE_CLONE_SAMPLE_TOO_SHORT | De gecombineerde fragmenten bevatten minder dan 10 seconden audio. |
| 400 | VOICE_SAMPLE_NOT_OWNED | Een fragmentsleutel is onveilig of is niet van het geauthenticeerde account. |
| 401 | API_KEY_EXPIRED | De API-sleutel is verlopen. |
| 401 | INVALID_API_KEY | Geef een geldige, niet-verlopen API-sleutel op. |
| 401 | INVALID_CREDENTIAL | De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key. |
| 401 | MISSING_CREDENTIAL | Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens. |
| 401 | USER_NOT_FOUND | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. |
| 403 | ACCOUNT_UNAVAILABLE | Het uitvoerende of factureringsaccount is niet beschikbaar of wordt verwijderd. |
| 403 | AMBIGUOUS_TEAM_API_KEY | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. |
| 403 | INSUFFICIENT_SCOPE | Verleen alle vereiste machtigingen of kies andere toegangsgegevens. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | De integratielimieten van het account konden niet worden geverifieerd. |
| 403 | SUBSCRIPTION_REQUIRED | Gebruik een actief betaald abonnement. |
| 403 | TEAM_OWNER_NOT_FOUND | Het effectieve account van de teameigenaar kon niet worden gevonden. |
| 403 | VOICE_CLONING_REQUIRES_PAID_PLAN | Met het huidige abonnement kun je geen aangepaste TTS-stemmen opslaan. |
| 404 | VOICE_CLONE_NOT_FOUND | De kloonaanvraag behoort niet tot het geauthenticeerde account of is niet meer beschikbaar. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | Voor dit account worden al 10 integratieacties uitgevoerd. Controleer een bestaande aanvraag voordat je een nieuwe start. |
| 409 | IDEMPOTENCY_CONFLICT | Gebruik een identificatie alleen opnieuw met dezelfde bewerking en argumenten. |
| 409 | VOICE_CLONE_IN_PROGRESS | Er wordt nog een kloon aangemaakt met deze requestId. |
| 409 | VOICE_CLONE_LIMIT_REACHED | Alle plaatsen voor opgeslagen aangepaste TTS-stemmen zijn bezet. |
| 409 | VOICE_CREATION_IN_PROGRESS | Stemwijzigingen worden geblokkeerd terwijl het account wordt verwijderd. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Wacht tot de maandelijkse reset of wijzig je abonnement. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen. |
| 500 | INTERNAL_ERROR | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. |
| 502 | INTERNAL_ERROR | De actie kon niet worden voltooid of het resultaat kon niet worden bevestigd. Controleer de aanvraagstatus en de resourcegeschiedenis voordat je een nieuwe generatie start. |
| 503 | ACTION_RESULT_UNAVAILABLE | De actie is uitgevoerd, maar het resultaat kon niet worden opgeslagen. Controleer de opgeslagen aanvraagstatus en resourcegeschiedenis voordat je een nieuwe generatie start. |
| 503 | SERVER_RESTARTING | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:write"]
}
}
Was deze pagina nuttig?

