> ## 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.
# Segmentspraak opnieuw genereren
> Plaats spraakregeneratie voor een segment in de wachtrij, vernieuw optioneel de lipsynchronisatie en gebruik het gebruikelijke mediategoed. requestId moet een stabiele UUID zijn. Controleer segment_actions_list.
Plaats spraakregeneratie voor een segment in de wachtrij, vernieuw optioneel de lipsynchronisatie en gebruik het gebruikelijke mediategoed. requestId moet een stabiele UUID zijn. Controleer segment\_actions\_list.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/segments_regenerate
```
## Authenticatie en machtigingen
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.
Vereiste machtigingen: `translations:write`.
Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.
## Parameters
Tekstwaarde.
Minimale lengte: 1. Maximale lengte: 200. Patroon: `^[^/\\]+$`.
Tekstwaarde.
Minimale lengte: 1. Maximale lengte: 200. Patroon: `^[^/\\]+$`.
Tekstwaarde.
Minimale lengte: 1. Maximale lengte: 200. Patroon: `^[^/\\]+$`.
Gehele waarde.
Minimum: 0. Maximum: 9007199254740991.
Optioneel op transportniveau: als de identificatie ontbreekt, voegt de server deze vóór de validatie toe. Geef zelf een stabiele UUID v4 op om veilig te kunnen herstellen als een antwoord verloren gaat.
Formaat: "uuid". Patroon: `^[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}$`.
Tekstwaarde.
Maximale lengte: 500.
Booleaanse waarde.
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.
```json theme={null}
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
},
"workId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
},
"translatedVersionId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
},
"segmentIndex": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
},
"requestId": {
"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}$",
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
},
"segmentTranslationInstructions": {
"type": "string",
"maxLength": 500
},
"regenerateLipSync": {
"type": "boolean"
}
},
"required": ["projectId", "workId", "translatedVersionId", "segmentIndex"],
"additionalProperties": false
}
```
## Idempotentie
Gebruik voor elke wijziging een UUID v4 in requestId of de HTTP-header Idempotency-Key. Gebruik na een netwerkfout dezelfde identificatie en identieke argumenten opnieuw. Als je beide opgeeft, moeten ze overeenkomen. Het opnieuw versturen van een opgeslagen aanvraag herhaalt de bewerking niet en verbruikt geen extra maandelijkse aanroep. Mislukte of onderbroken aanvragen worden niet automatisch opnieuw gestart.
Elke wijziging kan HTTP 202 retourneren wanneer een nieuwe poging vaststelt dat dezelfde aanvraag nog loopt, ook wanneer de eerste uitvoering normaal synchroon is. Als de uitvoering is voltooid maar resultStored false is, retourneert een nieuwe poging HTTP 200 met de opgeslagen aanvraagstatus in plaats van het oorspronkelijke resultaat. Haal de uitvoer op via de geschiedenis-, resultaat- of downloadactie van het betreffende domein.
## 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.
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/segments_regenerate' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","workId":"5f8423d1-e4c0-4f80-9e3f-eed959389e24","translatedVersionId":"0fa684f3-4997-4d7a-9424-16d1f9ac849c","segmentIndex":0,"requestId":"41321bda-e243-4b6f-96a4-622cd047c991","segmentTranslationInstructions":"Keep the product name unchanged.","regenerateLipSync":false}'
```
```javascript JavaScript theme={null}
const input = {
projectId: 'project_launch_2026',
workId: '5f8423d1-e4c0-4f80-9e3f-eed959389e24',
translatedVersionId: '0fa684f3-4997-4d7a-9424-16d1f9ac849c',
segmentIndex: 0,
requestId: '41321bda-e243-4b6f-96a4-622cd047c991',
segmentTranslationInstructions: 'Keep the product name unchanged.',
regenerateLipSync: false,
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segments_regenerate', {
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/segments_regenerate",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24", "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c", "segmentIndex": 0, "requestId": "41321bda-e243-4b6f-96a4-622cd047c991", "segmentTranslationInstructions": "Keep the product name unchanged.", "regenerateLipSync": False},
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 toelating tot de wachtrij voor het opnieuw genereren van één segment in een geautoriseerde vertaalversie.
```json HTTP 200 theme={null}
{
"data": {
"status": "queued",
"jobId": "41321bda-e243-4b6f-96a4-622cd047c991",
"queue": {
"projectId": "project_launch_2026",
"revision": 1,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "regenerate",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"segmentIndex": 0
},
"status": "queued",
"createdAt": 1792152000000
}
]
}
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
```
```json HTTP 202 replay_running theme={null}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "segments_regenerate",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
```
```json HTTP 200 replay_completed_without_result theme={null}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "segments_regenerate",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
}
```
## Resultaatvelden
| Veld | Beschrijving |
| - | - |
| `data.status` | started wanneer deze taak is geclaimd of begonnen; anders queued. Geen van beide waarden betekent dat de taak is voltooid. |
| `data.jobId` | ID van de wachtrijtaak, gelijk aan de stabiele requestId van de indiening. |
| `data.queue` | Actuele momentopname van de projectwachtrij, waarin de taak mogelijk al wordt uitgevoerd of een eindstatus heeft. |
| `data.queue.projectId` | ID van het bovenliggende project. |
| `data.queue.revision` | Revisie van de wachtrijmomentopname. Deze staat los van projects\_get.segmentStructureRevision. |
| `data.queue.items` | Voortgang van projectacties: taak-ID’s, actiemetagegevens, status, tijdstempels en een optionele openbare errorCode. |
| `data.queue.items[].id` | Taak-ID; gelijk aan de oorspronkelijke requestId waarmee de taak in de wachtrij is geplaatst. |
| `data.queue.items[].action` | Alleen actiemetagegevens: type, segmentIndex en optioneel workId, translatedVersionId en source. Ingediende tekst, tijdwaarden en instructies voor opnieuw genereren worden niet teruggegeven. |
| `data.queue.items[].status` | queued, running, completed, failed of cancelled. |
| `data.queue.items[].createdAt` | Aanmaaktijd van het wachtrij-item in Unix-milliseconden. |
| `data.queue.items[].startedAt` | Optioneel eerste starttijdstip in Unix-milliseconden. |
| `data.queue.items[].finishedAt` | Optioneel tijdstip van de eindstatus in Unix-milliseconden. |
| `data.queue.items[].errorCode` | Optionele openbare foutcode. Niet-geclassificeerde fouten gebruiken ACTION\_FAILED. |
| `data.queue.items[].seenAt` | Optionele bevestigingstijd, uitsluitend voor de aangemelde kijker. |
## Deze aanvraag herstellen en controleren
Gebruik dezelfde identificatie, ook nadat de verbinding is verbroken. Als resultStored false is, haal je de uitvoer op via de bijbehorende geschiedenis-, resultaat- of downloadactie. Start nooit een tweede generatie alleen om de voortgang te controleren.
```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":"41321bda-e243-4b6f-96a4-622cd047c991","operation":"segments_regenerate"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "segments_regenerate",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"status": "queued",
"jobId": "41321bda-e243-4b6f-96a4-622cd047c991",
"queue": {
"projectId": "project_launch_2026",
"revision": 1,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "regenerate",
"workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
"translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
"segmentIndex": 0
},
"status": "queued",
"createdAt": 1792152000000
}
]
}
}
}
}
```
## Opmerkingen bij de bewerking
* Gebruik één UUID v4 requestId voor de beoogde bewerking en hergebruik deze met identieke argumenten bij nieuwe pogingen. jobId is gelijk aan deze requestId.
* Toelating retourneert started of queued, geen voltooiing. Vraag segment\_actions\_list op en zoek items\[].id die gelijk zijn aan jobId totdat de status completed, failed of cancelled is. Vernieuw daarna transcripts\_get en projects\_get.
* queue.revision houdt de status van de wachtrij bij; het is geen revisie van de bronsegmentstructuur. Wachtrijacties leggen de huidige structuur vast bij toelating. Een latere onverenigbare structuurwijziging kan ervoor zorgen dat het item mislukt met SEGMENT\_STRUCTURE\_CHANGED.
* Er wordt slechts één wachtende actie voor hetzelfde logische segmentdoel geaccepteerd. Een nieuwe requestId omzeilt SEGMENT\_ACTION\_ALREADY\_PENDING niet.
* Uitvoeringsfouten in de wachtrij verschijnen als items\[].status failed plus errorCode, zonder het geslaagde indieningsresultaat te wijzigen.
* workId en translatedVersionId moeten bij het geselecteerde project en bij elkaar horen. De worker beoordeelt de huidige media, segmentstatus, rechten en het tegoed wanneer de uitvoering begint.
* segmentTranslationInstructions is optioneel en beperkt tot 500 tekens. regenerateLipSync true vraagt na de spraakgeneratie om de lipsynchronisatie van het segment opnieuw te genereren, met de laatst gebruikte lipsynchronisatiemodus van die versie.
* Normaal mediategoed is van toepassing. Een geslaagde toelating betekent niet dat het opnieuw genereren of de optionele lipsynchronisatie is geslaagd.
* Ververs projects\_get en transcripts\_get nadat het wachtrij-item is voltooid; de respons zelf bevat geen nieuwe audio- of video-URL.
* Wachtrijantwoorden bevatten ook bij indiening, annulering, polling en herhaling alleen actiemetagegevens. Lees transcriptinhoud met transcripts\_get en de vereiste machtiging transcription:read.
## 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 | `BAD_REQUEST` | De bronsegmentindex bestaat niet of de wachtrijargumenten zijn ongeldig. |
| 400 | `CREDENTIAL_IN_QUERY` | Inloggegevens zijn opgegeven in een queryparameter access\_token of api\_key. Stuur inloggegevens in headers. |
| 400 | `IDEMPOTENCY_CONFLICT` | De header Idempotency-Key en het bodyveld requestId moeten overeenkomen. |
| 400 | `INVALID_REQUEST_ID` | Geef een UUID v4 op als requestId of Idempotency-Key. |
| 400 | `SEGMENT_QUEUE_FULL` | Het project heeft al 50 wachtende segmentacties. |
| 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 | `ACCOUNT_UNAVAILABLE` | Het uitvoerende of factureringsaccount is niet beschikbaar of wordt verwijderd. |
| 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. |
| 404 | `TRANSLATION_NOT_FOUND` | De geselecteerde taalversie is niet van dit project. |
| 404 | `TRANSLATION_VERSION_NOT_FOUND` | De geselecteerde uitvoerversie hoort niet bij de taalversie. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Voor dit account worden al 10 integratieacties uitgevoerd. Controleer een bestaande aanvraag voordat je een nieuwe start. |
| 409 | `IDEMPOTENCY_CONFLICT` | Gebruik een identificatie alleen opnieuw met dezelfde bewerking en argumenten. |
| 409 | `SEGMENT_ACTION_ALREADY_PENDING` | Een actie voor hetzelfde logische doelsegment staat al in de wachtrij of wordt al uitgevoerd. |
| 409 | `SEGMENT_STRUCTURE_BUSY` | Er is een wijziging van de segmentstructuur actief; laad het project opnieuw voordat je opnieuw indient. |
| 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 | `ACTION_RESULT_UNAVAILABLE` | De actie is uitgevoerd, maar het resultaat kon niet worden opgeslagen. Controleer de opgeslagen aanvraagstatus en resourcegeschiedenis voordat je een nieuwe generatie start. |
| 503 | `INTERNAL_ERROR` | De segmentwachtrij is uitgeschakeld op de ontwikkelserver; de actie is niet toegelaten. |
| 503 | `SERVER_RESTARTING` | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["translations:write"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.