> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.
# Vorschau einer geklonten Stimme erstellen
> Erstellen Sie mit ausdrücklicher Erlaubnis eine temporäre Vorschau einer geklonten Stimme aus 1–3 Audiouploads Ihres Kontos. Verwendet das Testkontingent der App für Stimmenklone. Speichern Sie die ausgewählte Vorschau vor ihrem Ablauf, um sie zu behalten.
Erstellen Sie mit ausdrücklicher Erlaubnis eine temporäre Vorschau einer geklonten Stimme aus 1–3 Audiouploads Ihres Kontos. Verwendet das Testkontingent der App für Stimmenklone. Speichern Sie die ausgewählte Vorschau vor ihrem Ablauf, um sie zu behalten.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/voices_preview_clone
```
## Authentifizierung und Berechtigungen
Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt.
OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.
Erforderliche Berechtigungen: `voices:write`.
Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.
## Parameter
An der Transportschnittstelle optional: Bei fehlender Angabe fügt der Server vor der Validierung eine Kennung ein. Geben Sie eine eigene stabile UUID v4 an, um eine verlorene Antwort sicher wiederherstellen zu können.
Format: "uuid". Muster: `^[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}$`.
Textwert.
Mindestlänge: 1. Höchstlänge: 80.
Liste von Werten. Die Struktur der Elemente finden Sie im vollständigen Eingabeschema.
Mindestanzahl an Elementen: 1. Höchstanzahl an Elementen: 3.
Bestätigen Sie, dass Sie die Erlaubnis haben, die Stimme der Person zu klonen, deren Stimme in jeder Audioprobe zu hören ist.
Erforderlicher Wert: true.
Boolescher Wert.
Standardwert: false.
Textwert.
Höchstlänge: 35. Muster: `^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$`.
Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.
```json theme={null}
{
"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
}
```
## Idempotenz
Verwenden Sie für jede Mutation eine UUID v4 in requestId oder im HTTP-Header Idempotency-Key. Verwenden Sie nach einem Netzwerkfehler dieselbe Kennung und identische Argumente erneut. Wenn Sie beides angeben, müssen die Werte übereinstimmen. Die Wiederholung einer gespeicherten Anfrage führt die Operation nicht erneut aus und verbraucht keinen weiteren monatlichen Aufruf. Fehlgeschlagene oder unterbrochene Anfragen werden nicht automatisch neu gestartet.
Jede Mutation kann HTTP 202 zurückgeben, wenn bei einem Wiederholungsversuch dieselbe Anfrage noch läuft, auch wenn ihre erste Ausführung normalerweise synchron erfolgt. Wenn die Ausführung abgeschlossen ist, resultStored aber false ist, gibt ein Wiederholungsversuch HTTP 200 mit dem gespeicherten Anfragestatus anstelle des ursprünglichen Ergebnisses zurück. Rufen Sie die Ausgabe über die für ihren Bereich vorgesehene Verlaufs-, Ergebnis- oder Downloadaktion ab.
## Anfragebeispiele
Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_preview_clone' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","name":"Studio narrator","samples":[{"fileKey":"uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}],"hasPermission":true,"trimToMaxDuration":false,"language":"en"}'
```
```javascript JavaScript theme={null}
const input = {
requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
name: 'Studio narrator',
samples: [
{
fileKey: 'uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav',
},
],
hasPermission: true,
trimToMaxDuration: false,
language: 'en',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_preview_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);
```
```python Python theme={null}
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/voices_preview_clone",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "name": "Studio narrator", "samples": [{"fileKey": "uploads/example-user/66666666-6666-4666-8666-666666666666-narrator.wav"}], "hasPermission": True, "trimToMaxDuration": False, "language": "en"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## Antwort
Diese Operation gibt während der Ausführung HTTP 202 zurück. Speichern Sie requestId und fragen Sie action\_request\_get mit dieser Kennung und dem ursprünglichen Operationsnamen ab. Die Abfragestatus sind running, completed, failed und interrupted. Ein abgeschlossenes Ergebnis kann auf einen separaten Medienauftrag verweisen; verwenden Sie anschließend die für die Operation vorgesehene Status- oder Ausgabeaktion.
Alle aktiven ungespeicherten Stimmvorschauen und aktualisierten Erstellungskontingente, einschließlich des neuen Klonkandidaten.
```json HTTP 202 theme={null}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```
```json HTTP 200 theme={null}
{
"data": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 1,
"remaining": 0
},
"design": {
"limit": 5,
"used": 0,
"remaining": 5,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```
```json HTTP 202 replay_running theme={null}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_preview_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```
```json HTTP 200 replay_completed_without_result theme={null}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_preview_clone",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```
## Ergebnisfelder
| Feld | Beschreibung |
| - | - |
| `data.voicePreviews` | Alle derzeit aktiven ungespeicherten Vorschauen dieses Kontos, einschließlich Kandidaten aus früheren Anfragen. |
| `data.voicePreviews[].id` | Vorschau-UUID v4, die von voices\_preview\_get und voices\_save\_preview verwendet wird. |
| `data.voicePreviews[].kind` | clone oder design. |
| `data.voicePreviews[].name` | Anzeigename der Vorschau; entworfene Kandidaten hängen eine Zahl an den angefragten Namen an. |
| `data.voicePreviews[].previewUrl` | Temporäre URL für abspielbares Audio. Fordern Sie mit voices\_preview\_get eine neue URL an, solange die Vorschau aktiv bleibt. |
| `data.voicePreviews[].expiresAt` | Ablaufzeit der Vorschau als Unix-Zeitstempel in Millisekunden. |
| `data.voicePreviews[].durationSeconds` | Dauer der Audiovorschau in Sekunden. |
| `data.creationUsage.cloneTrial` | Lebenslanges Testkontingent für Klonvorschauen mit limit, used und remaining. |
| `data.creationUsage.design` | Tägliches Kontingent für Stimmentwürfe mit limit, used, remaining und resetsAt in Unix-Millisekunden. |
| `data.creationUsage.previewExpiresAfterHours` | Lebensdauer einer ungespeicherten Vorschau in Stunden, derzeit 24. |
## Diese Anfrage wiederherstellen und abfragen
Verwenden Sie auch nach einem Verbindungsabbruch dieselbe Kennung. Wenn resultStored den Wert false hat, rufen Sie die Ausgabe über die entsprechende Verlaufs-, Ergebnis- oder Downloadaktion ab. Starten Sie niemals eine zweite Generierung, nur um den Fortschritt zu prüfen.
```bash theme={null}
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":"284a861a-4da8-4d67-ad48-8123e76c8e91","operation":"voices_preview_clone"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
"operation": "voices_preview_clone",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"voicePreviews": [
{
"id": "44444444-4444-4444-8444-444444444444",
"kind": "clone",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/narrator-preview.mp3",
"expiresAt": 1792238400000,
"durationSeconds": 10
}
],
"creationUsage": {
"cloneTrial": {
"limit": 1,
"used": 1,
"remaining": 0
},
"design": {
"limit": 5,
"used": 0,
"remaining": 5,
"resetsAt": 1792195200000
},
"previewExpiresAfterHours": 24
}
}
}
}
```
## Hinweise zur Operation
* Verwenden Sie für diese Mutation eine requestId im Format UUID v4 und bei Wiederholungsversuchen dieselbe ID mit identischen Argumenten erneut. Lang laufende Aktionen geben zunächst eine Anfrage mit dem Status running zurück; dieses Beispiel zeigt das abgeschlossene Handler-Ergebnis, das über action\_request\_get verfügbar ist.
* Laden Sie 1–3 eigene Audiostimmproben hoch und verwenden Sie die fileKey-Werte der abgeschlossenen Uploads. Unterstützte Probenformate sind MP3, WAV, M4A, OGG und Opus; jede Datei muss nicht leer sein und darf höchstens 20 MiB (20,971,520 Bytes) groß sein. Entfernte URLs und Uploads anderer Konten werden abgelehnt.
* Die Stimmproben müssen zusammen mindestens 10 Sekunden und höchstens 120 Sekunden auslesbare Audiodaten umfassen. trimToMaxDuration ist standardmäßig false; setzen Sie den Wert auf true, um Stimmproben mit einer Gesamtdauer von mehr als 120 Sekunden anteilig zu kürzen.
* hasPermission muss der boolesche JSON-Wert true sein und die Erlaubnis für jede Audioprobe bestätigen. Ein Zeichenfolgenwert wie "true" wird abgelehnt.
* name muss nach dem Entfernen von Leerraum am Anfang und Ende 1–80 Zeichen enthalten. Das optionale language akzeptiert einen Code aus 2–3 Buchstaben mit optionalen Subtags und maximal 35 Zeichen.
* Verwendet den einmaligen Klonvorschau-Test des Kontos. Das Erstellen dieser Vorschau speichert keine wiederverwendbare TTS-Stimme und belegt keinen Speicherplatz für Stimmen.
* Der neue Klonkandidat hat kind: clone und ist 24 Stunden gültig. Seine Wiedergabe ist auf etwa 10 Sekunden begrenzt.
* Die Antwort enthält alle aktiven, nicht gespeicherten Vorschauen. Verwenden Sie voices\_preview\_get, um die Wiedergabe zu erneuern, und anschließend voices\_save\_preview, um den gewählten Kandidaten mit einem kostenpflichtigen Tarif zu behalten.
* language wählt das Vorschau-Skript aus, wenn ein unterstütztes Skript vorhanden ist; dies ist keine Anfrage zur Übersetzung des hochgeladenen Beispiels.
* Der Sprachausgabeverlauf und benutzerdefinierte Stimmen gehören dem authentifizierten Konto. Die Teamabrechnung gewährt keinen Zugriff auf die Sprachausgaben oder Stimmen anderer Mitglieder.
## Nutzung
Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.
## Fehler
| HTTP-Status | Code | Bedeutung oder Behebung |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Zugangsdaten wurden in einem Abfrageparameter namens access\_token oder api\_key übergeben. Senden Sie Zugangsdaten in Headern. |
| 400 | `IDEMPOTENCY_CONFLICT` | Der Header Idempotency-Key und das Feld requestId im Anfragetext müssen übereinstimmen. |
| 400 | `INVALID_REQUEST_ID` | Geben Sie eine UUID v4 als requestId oder Idempotency-Key an. |
| 400 | `VALIDATION_ERROR` | Die Eingabe entspricht nicht dem Aktionsschema; prüfen Sie details auf Feldfehler. |
| 400 | `VOICE_CLONE_INVALID_AUDIO` | Eine hochgeladene Audioprobe hat keine lesbare positive Audiodauer. |
| 400 | `VOICE_CLONE_INVALID_FILE_SIZE` | Ein gespeichertes Beispiel ist leer oder überschreitet 20 MiB. |
| 400 | `VOICE_CLONE_INVALID_FILE_TYPE` | Eine Stimmprobe ist keine MP3-, WAV-, M4A-, OGG- oder Opus-Audiodatei. |
| 400 | `VOICE_CLONE_SAMPLE_TOO_LONG` | Die kombinierten Beispiele überschreiten 120 Sekunden, und das Kürzen wurde nicht aktiviert. |
| 400 | `VOICE_CLONE_SAMPLE_TOO_SHORT` | Die zusammengefassten Audioproben enthalten weniger als 10 Sekunden Audio. |
| 400 | `VOICE_SAMPLE_NOT_OWNED` | Ein Audioprobenschlüssel ist unsicher oder gehört nicht dem authentifizierten Konto. |
| 401 | `API_KEY_EXPIRED` | Der API-Schlüssel ist abgelaufen. |
| 401 | `INVALID_API_KEY` | Geben Sie einen gültigen, nicht abgelaufenen API-Schlüssel an. |
| 401 | `INVALID_CREDENTIAL` | Der Authorization-Header ist fehlerhaft oder steht im Konflikt mit x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Es wurde kein nutzbarer Berechtigungsnachweis im Header übergeben, oder er überschritt 4096 Zeichen. |
| 401 | `USER_NOT_FOUND` | Das Konto des Zugangsnachweises existiert nicht mehr. |
| 403 | `ACCOUNT_UNAVAILABLE` | Das ausführende Konto oder das Abrechnungskonto ist nicht verfügbar oder wird gerade gelöscht. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | Der Benutzer des Berechtigungsnachweises gehört mehr als einem Team an, weshalb der Abrechnungskontext nicht eindeutig ist. |
| 403 | `INSUFFICIENT_SCOPE` | Erteilen Sie alle erforderlichen Berechtigungen oder verwenden Sie andere Zugangsdaten. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Die Integrationslimits des Kontos konnten nicht verifiziert werden. |
| 403 | `SUBSCRIPTION_REQUIRED` | Verwenden Sie ein aktives kostenpflichtiges Abonnement. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Das maßgebliche Konto des Teaminhabers wurde nicht gefunden. |
| 404 | `USER_NOT_FOUND` | Das authentifizierte Konto existiert nicht mehr. |
| 404 | `VOICE_PREVIEW_NOT_FOUND` | Die Anfrage gehört einem anderen Konto. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Für dieses Konto laufen bereits 10 Integrationsaktionen. Fragen Sie eine vorhandene Anfrage ab, bevor Sie eine weitere starten. |
| 409 | `IDEMPOTENCY_CONFLICT` | Verwenden Sie eine Kennung nur mit derselben Operation und denselben Argumenten erneut. |
| 409 | `VOICE_CREATION_IN_PROGRESS` | Die Vorschau wird noch erstellt oder die Kontolöschung blockiert neue Stimmoperationen. |
| 409 | `VOICE_CREATION_REQUEST_MISMATCH` | Diese requestId wurde für einen anderen Stimmtyp oder andere Einstellungen oder Beispiele verwendet. |
| 409 | `VOICE_TRIAL_LIMIT_REACHED` | Das Konto hat seine einmalig für die gesamte Kontolaufzeit verfügbare Testmöglichkeit für eine Klonvorschau bereits genutzt. |
| 410 | `VOICE_PREVIEW_EXPIRED` | Die Stimmvorschau der Anfrage ist abgelaufen oder nicht mehr verfügbar. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Warten Sie auf die monatliche Zurücksetzung oder wechseln Sie den Tarif. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Warten Sie gegebenenfalls die in Retry-After angegebene Zeit und verwenden Sie zunehmend längere Warteintervalle. |
| 500 | `INTERNAL_ERROR` | Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen. |
| 502 | `INTERNAL_ERROR` | Die Aktion konnte nicht abgeschlossen oder ihr Ergebnis nicht bestätigt werden. Prüfen Sie den Anfragestatus und den Ressourcenverlauf, bevor Sie eine weitere Generierung starten. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | Die Aktion wurde ausgeführt, ihr Ergebnis konnte jedoch nicht gespeichert werden. Prüfen Sie den gespeicherten Anfragestatus und den Ressourcenverlauf, bevor Sie eine neue Generierung starten. |
| 503 | `SERVER_RESTARTING` | Der Server wird neu gestartet. Versuchen Sie es in Kürze erneut und behalten Sie bei einer Mutation dieselbe Anfragekennung bei. |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:write"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.