curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_get', {
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/projects_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"projectName": "Product launch",
"status": "success",
"workflow": "translation",
"originalVideoUrl": "https://media.example.com/launch/original.mp4",
"originalLanguage": "fr",
"targetLanguages": [
"english"
],
"duration": 75,
"createdAt": 1792152000000,
"progress": {
"step": "done",
"transcriptionProgress": 100,
"transcriptionStatus": "success"
},
"translations": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"targetLanguage": "english",
"status": "completed",
"currentStep": "done",
"progress": 100,
"createdAt": 1792152060000,
"completedAt": 1792152300000,
"translatedVideoUrl": "https://media.example.com/launch/english.mp4",
"translatedAudioUrl": "https://media.example.com/launch/english.mp3",
"settings": {
"voiceCloning": true,
"uploadType": "video",
"keepBackgroundMusic": true,
"keepOriginalVoice": false,
"originalVoiceVolume": 30,
"subtitles": {
"isEnable": false,
"source": "translated"
},
"smartSync": true,
"dubbingMode": "translate",
"voiceIsolatorOption": "studio"
}
}
],
"segmentStructureRevision": 3,
"numberOfSpeakers": 1,
"translationInstructions": "",
"isReadyForDubbing": true,
"settings": {
"voiceCloning": true,
"customVoice": false,
"customVoiceId": "",
"keepBackgroundMusic": true,
"keepOriginalVoice": false,
"originalVoiceVolume": 30,
"activeSpeakerDetectionEnabled": false,
"subtitles": {
"isEnable": false,
"source": "translated"
},
"smartSync": true,
"voiceIsolatorOption": "studio",
"voiceCloningSettings": {
"stability": 0.5,
"similarity": 0.75
}
}
}
}
Projecten
Een project ophalen
Haal projectgegevens, bewerkbare instellingen, segmentrevisie, uitvoer-URL’s en vertaalversies op.
POST
/
v1
/
actions
/
projects_get
curl --request POST 'https://api.voicecheap.ai/v1/actions/projects_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_get', {
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/projects_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"projectName": "Product launch",
"status": "success",
"workflow": "translation",
"originalVideoUrl": "https://media.example.com/launch/original.mp4",
"originalLanguage": "fr",
"targetLanguages": [
"english"
],
"duration": 75,
"createdAt": 1792152000000,
"progress": {
"step": "done",
"transcriptionProgress": 100,
"transcriptionStatus": "success"
},
"translations": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"targetLanguage": "english",
"status": "completed",
"currentStep": "done",
"progress": 100,
"createdAt": 1792152060000,
"completedAt": 1792152300000,
"translatedVideoUrl": "https://media.example.com/launch/english.mp4",
"translatedAudioUrl": "https://media.example.com/launch/english.mp3",
"settings": {
"voiceCloning": true,
"uploadType": "video",
"keepBackgroundMusic": true,
"keepOriginalVoice": false,
"originalVoiceVolume": 30,
"subtitles": {
"isEnable": false,
"source": "translated"
},
"smartSync": true,
"dubbingMode": "translate",
"voiceIsolatorOption": "studio"
}
}
],
"segmentStructureRevision": 3,
"numberOfSpeakers": 1,
"translationInstructions": "",
"isReadyForDubbing": true,
"settings": {
"voiceCloning": true,
"customVoice": false,
"customVoiceId": "",
"keepBackgroundMusic": true,
"keepOriginalVoice": false,
"originalVoiceVolume": 30,
"activeSpeakerDetectionEnabled": false,
"subtitles": {
"isEnable": false,
"source": "translated"
},
"smartSync": true,
"voiceIsolatorOption": "studio",
"voiceCloningSettings": {
"stability": 0.5,
"similarity": 0.75
}
}
}
}
Haal projectgegevens, bewerkbare instellingen, segmentrevisie, uitvoer-URL’s en vertaalversies op.
Vereiste machtigingen:
POST https://api.voicecheap.ai/v1/actions/projects_get
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.
projects:read.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
Parameters
string
vereist
Tekstwaarde.Minimale lengte: 1. Maximale lengte: 200. Patroon:
^[^/\\]+$.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": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
}
},
"required": ["projectId"],
"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/projects_get' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/projects_get', {
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/projects_get",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
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. Retourneert de openbare projectgegevens, klantinstellingen, de huidige revisie van de bronstructuur en elke vertaalde uitvoerversie.{
"data": {
"projectId": "project_launch_2026",
"projectName": "Product launch",
"status": "success",
"workflow": "translation",
"originalVideoUrl": "https://media.example.com/launch/original.mp4",
"originalLanguage": "fr",
"targetLanguages": [
"english"
],
"duration": 75,
"createdAt": 1792152000000,
"progress": {
"step": "done",
"transcriptionProgress": 100,
"transcriptionStatus": "success"
},
"translations": [
{
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"targetLanguage": "english",
"status": "completed",
"currentStep": "done",
"progress": 100,
"createdAt": 1792152060000,
"completedAt": 1792152300000,
"translatedVideoUrl": "https://media.example.com/launch/english.mp4",
"translatedAudioUrl": "https://media.example.com/launch/english.mp3",
"settings": {
"voiceCloning": true,
"uploadType": "video",
"keepBackgroundMusic": true,
"keepOriginalVoice": false,
"originalVoiceVolume": 30,
"subtitles": {
"isEnable": false,
"source": "translated"
},
"smartSync": true,
"dubbingMode": "translate",
"voiceIsolatorOption": "studio"
}
}
],
"segmentStructureRevision": 3,
"numberOfSpeakers": 1,
"translationInstructions": "",
"isReadyForDubbing": true,
"settings": {
"voiceCloning": true,
"customVoice": false,
"customVoiceId": "",
"keepBackgroundMusic": true,
"keepOriginalVoice": false,
"originalVoiceVolume": 30,
"activeSpeakerDetectionEnabled": false,
"subtitles": {
"isEnable": false,
"source": "translated"
},
"smartSync": true,
"voiceIsolatorOption": "studio",
"voiceCloningSettings": {
"stability": 0.5,
"similarity": 0.75
}
}
}
}
Resultaatvelden
| Veld | Beschrijving |
|---|---|
data.projectId | Identificatie van een toegankelijk project. |
data.projectName | Projectnaam die zichtbaar is voor de klant. |
data.status | Projectoverzicht: processing, success of failed. |
data.workflow | transcription voor projecten met alleen transcriptie; translation voor nasynchronisatieprojecten. |
data.originalVideoUrl | Oorspronkelijke opgeslagen media-URL, ook voor audioprojecten; een lege tekenreeks als deze ontbreekt. |
data.originalLanguage | Gedetecteerde of geselecteerde brontaal; unknown als deze niet beschikbaar is. |
data.targetLanguages | Array met namen van doeltalen. |
data.duration | Duur van de oorspronkelijke media in seconden. |
data.createdAt | Aanmaaktijd van het project in Unix-milliseconden. |
data.progress | Openbare step voor transcriptie, optionele transcriptionProgress en transcriptionStatus. |
data.translations | Alle vertaalde versies van alle taalversies, gesorteerd met de nieuwste eerst op basis van de genormaliseerde createdAt. |
data.segmentStructureRevision | Huidige revisie van de bronsegmentstructuur, standaard 0. Geef deze waarde op als expectedSegmentStructureRevision voor segments_delete of segments_merge. |
data.numberOfSpeakers | Opgeslagen aantal bronsprekers, indien aanwezig. |
data.translationInstructions | Huidige vertaalinstructies van het project; lege string wanneer er geen zijn opgeslagen. |
data.isReadyForDubbing | Alleen true wanneer het opgeslagen project als gereed voor nasynchronisatie is gemarkeerd. |
data.settings | Optionele klantinstellingen uit de nasynchronisatie-instellingen van het project of oudere instellingen. Alleen opgeslagen velden worden geretourneerd; afwezige optionele waarden worden weggelaten. |
data.settings.voiceCloning | Optionele voorkeur voor stemklonen in het project. |
data.settings.customVoice | Optionele voorkeur voor een aangepaste stem. |
data.settings.customVoiceId | Optionele identificatie van de aangepaste stem. |
data.settings.keepBackgroundMusic | Optionele voorkeur voor achtergrondgeluid. |
data.settings.keepOriginalVoice | Optionele voorkeur voor de oorspronkelijke spraak. |
data.settings.originalVoiceVolume | Optioneel volume van de oorspronkelijke spraak. |
data.settings.activeSpeakerDetectionEnabled | Optionele voorkeur voor actieve-sprekerdetectie. |
data.settings.subtitles | Optionele ondertitelvoorkeur {isEnable,source}. |
data.settings.smartSync | Optionele SmartSync-voorkeur. |
data.settings.voiceIsolatorOption | Optionele stemisolatievoorkeur: studio of realistic. |
data.settings.voiceCloningSettings | Optionele stemkloonvoorkeuren {stability,similarity}. |
data.error | Optionele openbare {code,message} voor een verwerkingsfout op projectniveau. |
data.translations[].workId | Identificatie van de taalversie die deze versie bevat. |
data.translations[].translatedVersionId | Identificatie van een specifieke uitvoerversie van de nasynchronisatie. |
data.translations[].targetLanguage | Doeltaal van de versie, met de taalversie als terugval. |
data.translations[].status | Opgeslagen versiestatus: not-started, in-progress, completed of failed. |
data.translations[].currentStep | Optionele stap in de nasynchronisatiepipeline; progress is een optionele numerieke voortgangswaarde. |
data.translations[].progress | Optionele voortgangswaarde voor nasynchronisatie. |
data.translations[].createdAt | Aanmaaktijd genormaliseerd tot Unix-milliseconden; valt terug op de aanmaaktijd van de taalversie. |
data.translations[].completedAt | Optionele voltooiingstijd in Unix-milliseconden. |
data.translations[].failedAt | Optionele fouttijd in Unix-milliseconden. |
data.translations[].timedOutAt | Optionele time-outtijd in Unix-milliseconden. |
data.translations[].translatedVideoUrl | Opgeslagen URL van de vertaalde video, of een lege string indien niet beschikbaar. |
data.translations[].translatedAudioUrl | Opgeslagen URL van de vertaalde audio, of een lege string indien niet beschikbaar. |
data.translations[].error | Optionele {code,message} wanneer de versie is mislukt. |
data.translations[].settings | Openbare versie-instellingen: voiceCloning, uploadType, keepBackgroundMusic, keepOriginalVoice, originalVoiceVolume, subtitles, smartSync, dubbingMode, voiceIsolatorOption en optioneel translationQualityMode, cutBecauseFreeUser, originalDurationSeconds, cutDurationSeconds, voiceCloningSettings. |
data.translations[].settings.dubbingMode | translate of dub-only. SmartSync is false voor versies met dub-only. |
data.translations[].lipSync | Optionele {latest,history}; elk item bevat jobId, status, videoUrl, errorMessage, type, createdAt en optioneel requestedAt, retryRequestedAt, completedAt, failedAt, timedOutAt, activeSpeakerDetectionEnabled, isRetried. Lipsynchronisatietijden zijn opgeslagen als ISO-strings. |
data.translations[].dynamicSubtitles | Optioneel object met used, inProgress, magicZooms, magicBrolls, magicBrollsPercentage, videoUrl, errorMessage en optioneel removeSilencePace, removeBadTakes, templateName, requestedAt, rerunCount. requestedAt is in Unix-milliseconden. |
data.translations[].publicationAttempts | Optionele array met openbare publicatiepogingen: id, status, origin, plus optioneel scheduledAt, processingStartedAt, publishedAt, failedAt, privacyStatus, url, videoId, errorMessage. |
data.translations[].publishedVideos | Optionele array met type, videoId, privacyStatus en optioneel url, datePublished, origin, scheduledAt, plannedPublicationId. |
Opmerkingen bij de bewerking
- Deze actie retourneert geen transcripttekst of ruwe segmentdocumenten. Gebruik transcripts_get voor de transcriptinhoud en translations_list voor metadata van taalversies.
- Ontbrekende optionele geneste velden worden weggelaten uit de geserialiseerde JSON. Uitvoer-URL’s zijn lege strings totdat de bijbehorende uitvoer beschikbaar is.
- De projectstatus vat de workflow en de nieuwste vertaalversie samen; bekijk de afzonderlijke items in translations[] wanneer je meerdere talen beheert.
- Het veld error beschrijft een opgeslagen verwerkingsfout; het geslaagd ophalen van een mislukt project retourneert nog steeds een normaal resultaat.
- Opgeslagen fouten geven VoiceCheap-foutcodes en vaste berichten terug. Gebruik de code en de huidige resourcestatus om te bepalen hoe u kunt herstellen.
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 | Corrigeer de invoer aan de hand van het schema. Ongeldige of tegenstrijdige waarden worden vóór de uitvoering geweigerd. |
| 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 | FORBIDDEN | De geauthenticeerde uitvoerende gebruiker heeft geen toegang tot dit project. |
| 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 | PROJECT_NOT_FOUND | Het project bestaat niet in het toegankelijke account. |
| 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": ["projects:read"]
}
}
Was deze pagina nuttig?

