curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"uploadId":"a1b2c3d4-e5f6-4789-8abc-def012345678","parts":[{"partNumber":1,"etag":"0123456789abcdef0123456789abcdef"}],"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
uploadId: 'a1b2c3d4-e5f6-4789-8abc-def012345678',
parts: [
{
partNumber: 1,
etag: '0123456789abcdef0123456789abcdef',
},
],
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_upload_complete', {
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_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678", "parts": [{"partNumber": 1, "etag": "0123456789abcdef0123456789abcdef"}], "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
Stimmen für die Sprachausgabe
Medienupload abschließen (Stimmproben)
Schließen Sie Ihre hochgeladenen Teile ab und erhalten Sie den fileKey Ihres Kontos für Generierungsaktionen.
POST
/
v1
/
actions
/
voices_upload_complete
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"uploadId":"a1b2c3d4-e5f6-4789-8abc-def012345678","parts":[{"partNumber":1,"etag":"0123456789abcdef0123456789abcdef"}],"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
uploadId: 'a1b2c3d4-e5f6-4789-8abc-def012345678',
parts: [
{
partNumber: 1,
etag: '0123456789abcdef0123456789abcdef',
},
],
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_upload_complete', {
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_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678", "parts": [{"partNumber": 1, "etag": "0123456789abcdef0123456789abcdef"}], "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
Schließen Sie Ihre hochgeladenen Teile ab und erhalten Sie den fileKey Ihres Kontos für Generierungsaktionen.
Erforderliche Berechtigungen:
POST https://api.voicecheap.ai/v1/actions/voices_upload_complete
Authentifizierung und Berechtigungen
string
erforderlich
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.
voices:write.
Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.
Parameter
string
erforderlich
Textwert.Format: “uuid”. Muster:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.array
erforderlich
Liste von Werten. Die Struktur der Elemente finden Sie im vollständigen Eingabeschema.Mindestanzahl an Elementen: 1. Höchstanzahl an Elementen: 10000.
string
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}$.Vollständiges Eingabeschema
Vollständiges Eingabeschema
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.
{
"type": "object",
"properties": {
"uploadId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
},
"parts": {
"minItems": 1,
"maxItems": 10000,
"type": "array",
"items": {
"type": "object",
"properties": {
"partNumber": {
"type": "integer",
"minimum": 1,
"maximum": 10000
},
"etag": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"pattern": "^[^\\r\\n]+$"
}
},
"required": ["partNumber", "etag"],
"additionalProperties": false
}
},
"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}$"
}
},
"required": ["uploadId", "parts"],
"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.curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_upload_complete' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"uploadId":"a1b2c3d4-e5f6-4789-8abc-def012345678","parts":[{"partNumber":1,"etag":"0123456789abcdef0123456789abcdef"}],"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
uploadId: 'a1b2c3d4-e5f6-4789-8abc-def012345678',
parts: [
{
partNumber: 1,
etag: '0123456789abcdef0123456789abcdef',
},
],
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_upload_complete', {
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_upload_complete",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"uploadId": "a1b2c3d4-e5f6-4789-8abc-def012345678", "parts": [{"partNumber": 1, "etag": "0123456789abcdef0123456789abcdef"}], "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
Antwort
Eine erfolgreiche erste Ausführung gibt HTTP 200 mit dem Ergebnis der Operation unter data zurück. Bei einer Wiederholung kann stattdessen der gespeicherte Anfragestatus zurückgegeben werden. Das Beispiel zeigt eine unterstützte Antwort, nicht alle optionalen Felder. Der fertiggestellte eigene fileKey und die URL zum Lesen der Medien. Übergeben Sie fileKey an die nächste Generierungs- oder Stimmaktion.{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_complete",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
Ergebnisfelder
| Feld | Beschreibung |
|---|---|
data.fileKey | Eigene abgeschlossene Upload-Referenz, die von Generierungs- und Stimmaktionen verwendet wird. |
data.readUrl | Für die abgeschlossene Quelldatei zurückgegebene Lese-URL. Behandeln Sie sie als private Medienzugangsdaten. |
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.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":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"voices_upload_complete"}'
HTTP 200
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "voices_upload_complete",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-voice-sample.wav"
}
}
}
Hinweise zur Operation
- Erfordert ein kostenpflichtiges Abonnement und die Aktionsberechtigung. Der persönliche Tooltarif des handelnden Kontos wird bei der Ausführung erneut geprüft; gespeicherte Tools und Uploadreferenzen gehören diesem Konto, auch wenn die Zugangsdaten einem Team zugeordnet sind.
- Eine erfolgreiche Aktion verbraucht einen gemeinsamen monatlichen API/MCP-Aufruf. Beginner erlaubt 500, Starter 5,000 und Creator 25,000 Aufrufe/Monat; Pro, Scale und Enterprise haben keine monatliche Obergrenze. Limits pro Minute gelten weiterhin: jeweils 30, 60, 120, 180, 300 und 600. Generierungskontingente der Werkzeuge sind davon getrennt.
- Verwenden Sie eine UUID v4 als requestId oder einen identischen Idempotency-Key-Header und behalten Sie bei erneuten Versuchen dieselbe Aktion, ID und dieselben Argumente bei. Eine zwischengespeicherte Wiederholung verbraucht keinen weiteren monatlichen Aufruf.
- Das Upload-Präfix bestimmt die erforderliche Berechtigung. tools verwendet transcription:write, subtitles verwendet subtitles:write, projects verwendet projects:write und voices verwendet voices:write.
- Stimmproben unterstützen nur MP3-, WAV-, M4A-, OGG- oder Opus-Audio und sind auf 20 MiB (20,971,520 Bytes) begrenzt. Der MIME-Typ muss einer der dokumentierten Audiotypen sein. kind hat den Standardwert voice_sample; diese Familie hat keine upload_import-Aktion.
- Verwenden Sie den fileKey der vollständig hochgeladenen Stimmprobe mit der entsprechenden Aktion zur Stimmerstellung. Der Upload allein erstellt keine Stimme und generiert keine Sprachausgabe.
- Beim Signieren, Abschließen und Abbrechen von Stimm-Uploads wird ebenfalls geprüft, ob die bestehende Sitzung Audio enthält und höchstens 20 MiB groß ist; eine andere größere Sitzung oder Videositzung kann nicht über diese Berechtigung verwendet werden.
- Übermitteln Sie jeden hochgeladenen Teil genau einmal mit dem von seinem PUT zurückgegebenen ETag. Die Teile werden vor dem Abschluss nach partNumber sortiert; ETags dürfen umschließende Anführungszeichen enthalten oder weglassen.
- Ein erfolgreicher Abschluss entfernt die aktive Sitzung. Verwenden Sie dieselbe requestId erneut, um das Ergebnis nach dem Verlust einer Antwort wiederherzustellen; reichen Sie keinen neuen Abschluss für die bereits verbrauchte Sitzung ein.
- Das Abschließen eines Uploads verbraucht kein tägliches Generierungskontingent. Die separate Generierung bestimmt die Mediennutzung.
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 | BAD_REQUEST | Teile fehlen, sind doppelt vorhanden oder liegen außerhalb des gültigen Bereichs; geben Sie jeden Teil genau einmal an. |
| 400 | CREDENTIAL_IN_QUERY | Zugangsdaten wurden in einem Abfrageparameter namens access_token oder api_key übergeben. Senden Sie Zugangsdaten in Headern. |
| 400 | IDEMPOTENCY_CONFLICT | Die Anfrage-IDs im Header und im Body unterscheiden sich. |
| 400 | INVALID_REQUEST_ID | requestId oder Idempotency-Key ist keine UUID v4. |
| 400 | UPLOAD_SIZE_MISMATCH | Die gespeicherten Bytes weichen von der angegebenen fileSize ab oder überschreiten 20 MiB. Das ungültige Objekt und die Upload-Sitzung werden verworfen. |
| 400 | UPLOAD_TYPE_NOT_ALLOWED | Die eigene Sitzung überschreitet 20 MiB oder ihr MIME-Typ ist kein zulässiger Audiotyp für Stimmproben. |
| 400 | VALIDATION_ERROR | Die Argumente entsprechen nicht dem Aktionsschema, oder es wurde ein unbekanntes Argument angegeben. |
| 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 | UNAUTHORIZED | Die Upload-Sitzung gehört einem anderen authentifizierten Akteur. |
| 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 | Dem API-Schlüssel oder der MCP-Verbindung fehlt die erforderliche Aktionsberechtigung. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Die Integrationslimits des Kontos konnten nicht verifiziert werden. |
| 403 | PAID_SUBSCRIPTION_REQUIRED | Der authentifizierte Akteur hat kein kostenpflichtiges Abonnement mehr, wenn diese Werkzeugaktion ausgeführt wird. |
| 403 | SUBSCRIPTION_REQUIRED | Verwenden Sie ein aktives kostenpflichtiges Abonnement. |
| 403 | TEAM_OWNER_NOT_FOUND | Das maßgebliche Konto des Teaminhabers wurde nicht gefunden. |
| 404 | NOT_FOUND | Die Upload-Sitzung fehlt, ist abgelaufen, abgeschlossen oder abgebrochen. |
| 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. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Verbrauchte und ausstehende Aufrufe haben das gemeinsame monatliche API/MCP-Kontingent erreicht. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Das Konto hat sein Integrationslimit pro Minute erreicht; prüfen Sie retryAfterSeconds. |
| 500 | INTERNAL_ERROR | Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen. |
| 503 | ACTION_RESULT_UNAVAILABLE | Die Aktion wurde ausgeführt, aber die dauerhafte Speicherung des Anfrageergebnisses konnte nicht bestätigt werden. Fragen Sie dieselbe Aktion mit derselben requestId regelmäßig ab und prüfen Sie den Ressourcenverlauf, bevor Sie einen weiteren Schreibvorgang starten. |
| 503 | INTERNAL_ERROR | Der Dienst für Uploadsitzungen ist nicht verfügbar. Prüfen Sie die ursprüngliche Anfrage, bevor Sie einen Schreibvorgang erneut versuchen. |
| 503 | SERVER_RESTARTING | Der Server wird neu gestartet. Versuchen Sie es in Kürze erneut und behalten Sie bei einer Mutation dieselbe Anfragekennung bei. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["voices:write"]
}
}
War diese Seite hilfreich?

