curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"voices": [
{
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
{
"id": "933563129e564b19a115bedd57b7406a",
"name": "Sarah",
"accent": "english",
"gender": "female",
"style": "conversational",
"previewFileName": "sarah-en.mp3",
"source": "catalog"
}
],
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
},
"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
}
}
}
Stimmen für die Sprachausgabe
Stimmen und Stimmenvorschauen auflisten
Listen Sie verfügbare Stimmen für die Sprachausgabe, Ihre gespeicherten eigenen Stimmen, abspielbare nicht abgelaufene Vorschauen und Ihre Kontingente zur Stimmenerstellung auf.
POST
/
v1
/
actions
/
voices_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/voices_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"voices": [
{
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
{
"id": "933563129e564b19a115bedd57b7406a",
"name": "Sarah",
"accent": "english",
"gender": "female",
"style": "conversational",
"previewFileName": "sarah-en.mp3",
"source": "catalog"
}
],
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
},
"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
}
}
}
Listen Sie verfügbare Stimmen für die Sprachausgabe, Ihre gespeicherten eigenen Stimmen, abspielbare nicht abgelaufene Vorschauen und Ihre Kontingente zur Stimmenerstellung auf.
Erforderliche Berechtigungen:
POST https://api.voicecheap.ai/v1/actions/voices_list
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:read.
Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.
Parameter
Senden Sie ein leeres JSON-Objekt. Diese Aktion hat keine Eingabefelder.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": {},
"additionalProperties": false
}
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_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{}'
const input = {};
const response = await fetch('https://api.voicecheap.ai/v1/actions/voices_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={},
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. Verfügbare TTS-Katalogstimmen und eigene gespeicherte benutzerdefinierte Stimmen, Kontingent für Speicherplätze, aktive nicht gespeicherte Vorschauen und Kontingente für die Stimmerstellung.{
"data": {
"voices": [
{
"accent": "original",
"id": "clone:33333333-3333-4333-8333-333333333333",
"name": "Studio narrator",
"previewUrl": "https://files.example.com/saved-narrator.mp3",
"source": "clone"
},
{
"id": "933563129e564b19a115bedd57b7406a",
"name": "Sarah",
"accent": "english",
"gender": "female",
"style": "conversational",
"previewFileName": "sarah-en.mp3",
"source": "catalog"
}
],
"cloneUsage": {
"canClone": true,
"limit": 10,
"remaining": 9,
"used": 1
},
"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
}
}
}
Ergebnisfelder
| Feld | Beschreibung |
|---|---|
data.voices | Eigene gespeicherte TTS-Stimmen, gefolgt von verfügbaren Katalogstimmen. |
data.voices[].id | TTS-Auswahl-ID für tts_generate; benutzerdefinierte Werte verwenden clone:<UUID>. |
data.voices[].name | Anzeigename der Stimme. |
data.voices[].source | catalog oder clone. |
data.voices[].accent | Akzent der Stimme; original bei benutzerdefinierten Stimmen. |
data.voices[].gender | Optionales Geschlecht der Katalogstimme. |
data.voices[].style | Optionaler Vortragsstil einer Katalogstimme. |
data.voices[].previewFileName | Optionaler Dateiname einer mitgelieferten Katalogvorschau; dies ist keine Download-URL. |
data.voices[].previewUrl | Optionale abspielbare URL; URLs benutzerdefinierter Stimmen sind temporär. |
data.cloneUsage.canClone | Ob der aktuelle Tarif gespeicherte benutzerdefinierte TTS-Stimmen erlaubt; prüfen Sie remaining auf verfügbare Plätze. |
data.cloneUsage.limit | Tarifgrenze für gespeicherte benutzerdefinierte TTS-Stimmenplätze. |
data.cloneUsage.used | Belegte TTS-Stimmplätze einschließlich reservierter Erstellungen. |
data.cloneUsage.remaining | Verfügbare Speicherplätze für TTS-Stimmen. |
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. |
Hinweise zur Operation
- Der Beispielkatalog ist gekürzt. Die Aktion gibt die verfügbare TTS-Bibliothek zurück, wobei gespeicherte benutzerdefinierte Stimmen vor den Katalogeinträgen stehen.
- Verwenden Sie voices[].id in tts_generate. Gespeicherte Stimmen verwenden clone:<UUID>; Katalog-IDs sind opak. Diese IDs sind von dubbing_voices_list getrennt.
- Katalogeinträge enthalten accent, gender, style und previewFileName; previewUrl ist optional. Gespeicherte benutzerdefinierte Einträge enthalten accent: original, source: clone und eine temporäre previewUrl.
- canClone gibt an, ob der Tarif gespeicherte benutzerdefinierte TTS-Stimmen unterstützt; remaining gibt freie Plätze an. Reservierte Erstellungen können zu used zählen.
- voicePreviews enthält nur eigene, ungespeicherte, bereite Kandidaten, die noch nicht abgelaufen sind. Eine Vorschau gilt 24 Stunden; ihre abspielbare URL kann früher ablaufen.
- cloneTrial ist ein lebenslanges Kontingent für eine Klonvorschau. Kostenpflichtige Tarife erlauben fünf Designanfragen pro UTC-Tag; jedes erfolgreiche Design erstellt zwei Kandidaten. creationUsage meldet das aktuelle Kontingent und den Zeitpunkt der Zurücksetzung.
- 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 | VALIDATION_ERROR | Die Eingabe entspricht nicht dem Aktionsschema; prüfen Sie details auf Feldfehler. |
| 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 | 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. |
| 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. |
| 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:read"]
}
}
War diese Seite hilfreich?

