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
}
}
}
Spraakstemmen
Stemmen en stemvoorbeelden weergeven
Geef beschikbare spraakstemmen, je opgeslagen aangepaste stemmen, afspeelbare niet-verlopen voorbeelden en je limieten voor het maken van stemmen weer.
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
}
}
}
Geef beschikbare spraakstemmen, je opgeslagen aangepaste stemmen, afspeelbare niet-verlopen voorbeelden en je limieten voor het maken van stemmen weer.
Vereiste machtigingen:
POST https://api.voicecheap.ai/v1/actions/voices_list
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:read.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
Parameters
Stuur een leeg JSON-object. Deze actie heeft geen invoervelden.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": {},
"additionalProperties": false
}
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_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)
Antwoord
Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden. Beschikbare TTS-catalogusstemmen en eigen opgeslagen aangepaste stemmen, het tegoed voor opslagplaatsen, actieve niet-opgeslagen voorbeelden en tegoeden voor het maken van stemmen.{
"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
}
}
}
Resultaatvelden
| Veld | Beschrijving |
|---|---|
data.voices | Opgeslagen TTS-stemmen die je bezit, gevolgd door beschikbare catalogusstemmen. |
data.voices[].id | TTS-selectie-ID voor tts_generate; aangepaste waarden gebruiken clone:<UUID>. |
data.voices[].name | Weergavenaam van de stem. |
data.voices[].source | catalog of clone. |
data.voices[].accent | Stemaccent; original voor aangepaste stemmen. |
data.voices[].gender | Optioneel geslacht van de catalogusstem. |
data.voices[].style | Optionele spreekstijl van de stem uit de catalogus. |
data.voices[].previewFileName | Optionele bestandsnaam van het meegeleverde catalogusvoorbeeld; dit is geen download-URL. |
data.voices[].previewUrl | Optionele afspeelbare URL; URL’s voor aangepaste stemmen zijn tijdelijk. |
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. |
data.voicePreviews | Alle momenteel actieve, niet-opgeslagen previews voor dit account, inclusief kandidaten uit eerdere aanvragen. |
data.voicePreviews[].id | UUID v4 van het voorbeeld, gebruikt door voices_preview_get en voices_save_preview. |
data.voicePreviews[].kind | clone of design. |
data.voicePreviews[].name | Weergavenaam van de preview; bij ontworpen kandidaten wordt een nummer aan de aangevraagde naam toegevoegd. |
data.voicePreviews[].previewUrl | Tijdelijke afspeelbare audio-URL. Vraag met voices_preview_get een nieuwe URL aan zolang het voorbeeld actief blijft. |
data.voicePreviews[].expiresAt | Vervaltijd van het voorbeeld als Unix-tijdstempel in milliseconden. |
data.voicePreviews[].durationSeconds | Duur van de preview-audio in seconden. |
data.creationUsage.cloneTrial | Proeflimiet voor kloonvoorbeelden gedurende de levensduur van het account, met limit, used en remaining. |
data.creationUsage.design | Dagelijks quotum voor stemontwerp met limit, used, remaining en resetsAt in Unix-milliseconden. |
data.creationUsage.previewExpiresAfterHours | Geldigheidsduur van een niet-opgeslagen voorbeeld in uren, momenteel 24. |
Opmerkingen bij de bewerking
- De voorbeeldcatalogus is ingekort. De actie retourneert de beschikbare TTS-bibliotheek met opgeslagen aangepaste stemmen vóór de catalogusvermeldingen.
- Gebruik voices[].id in tts_generate. Opgeslagen stemmen gebruiken clone:<UUID>; catalogus-ID’s zijn ondoorzichtig. Deze ID’s staan los van dubbing_voices_list.
- Catalogusitems bevatten accent, gender, style en previewFileName; previewUrl is optioneel. Opgeslagen aangepaste items bevatten accent: original, source: clone en een tijdelijke previewUrl.
- canClone geeft aan of het abonnement opgeslagen aangepaste TTS-stemmen ondersteunt; remaining geeft het aantal vrije plaatsen aan. Gereserveerde aanmaakacties kunnen meetellen in used.
- voicePreviews bevat alleen eigen, niet-opgeslagen, gereedstaande kandidaten die niet zijn verlopen. Een voorbeeld is 24 uur geldig; de afspeelbare URL kan eerder verlopen.
- cloneTrial is een limiet van één kloonvoorbeeld gedurende de levensduur van het account. Betaalde abonnementen hebben vijf ontwerpaanvragen per UTC-dag; elk geslaagd ontwerp maakt twee kandidaten aan. creationUsage geeft de huidige limiet en het resettijdstip weer.
- 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 | VALIDATION_ERROR | De invoer komt niet overeen met het actieschema; controleer details op veldfouten. |
| 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 | 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. |
| 404 | USER_NOT_FOUND | Het aangemelde account bestaat niet meer. |
| 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. |
| 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:read"]
}
}
Was deze pagina nuttig?

