> ## 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.
# Modifica un segmento della trascrizione
> Metti in coda una modifica del testo originale o tradotto. requestId deve essere un UUID stabile per i nuovi tentativi. Interroga segment_actions_list per verificarne il completamento.
Metti in coda una modifica del testo originale o tradotto. requestId deve essere un UUID stabile per i nuovi tentativi. Interroga segment\_actions\_list per verificarne il completamento.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/segments_text_update
```
## Autenticazione e autorizzazioni
Invia una chiave API VoiceCheap in questa intestazione. È supportato anche Authorization: Bearer con la stessa chiave API. I token di accesso OAuth
sono accettati solo da MCP, non da questo endpoint REST.
Autorizzazioni richieste: `transcription:write`.
È necessario un abbonamento a pagamento attivo. Le autorizzazioni non modificano i ruoli del team, la proprietà delle risorse, i crediti multimediali o i limiti del piano.
## Parametri
Valore testuale.
Lunghezza minima: 1. Lunghezza massima: 200. Pattern: `^[^/\\]+$`.
Valore intero.
Minimo: 0. Massimo: 9007199254740991.
Facoltativo al livello di trasporto: se omesso, il server inserisce un identificatore prima della validazione. Fornisci un tuo UUID v4 stabile per recuperare in sicurezza una risposta persa.
Formato: "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}$`.
Valore testuale.
Valori consentiti: "original", "translated".
Valore testuale.
Lunghezza minima: 1. Lunghezza massima: 200. Pattern: `^[^/\\]+$`.
Valore testuale.
Lunghezza massima: 3000.
Valore booleano.
Il JSON Schema seguente conserva i nomi esatti dei campi, i tipi annidati, i valori predefiniti, i limiti e i valori accettati esposti dalla discovery. Le ulteriori regole tra campi sono elencate nelle note sull'operazione.
```json theme={null}
{
"type": "object",
"properties": {
"projectId": {
"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."
},
"source": {
"type": "string",
"enum": ["original", "translated"]
},
"workId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
},
"text": {
"type": "string",
"maxLength": 3000
},
"enableEditing": {
"type": "boolean"
}
},
"required": ["projectId", "segmentIndex", "source", "text"],
"additionalProperties": false
}
```
## Idempotenza
Usa un UUID v4 in requestId o nell'intestazione HTTP Idempotency-Key per ogni modifica. Riutilizza lo stesso identificatore e argomenti identici dopo un errore di rete. Se vengono forniti entrambi, devono coincidere. Ripetere una richiesta salvata non ripete l'operazione e non consuma un'altra chiamata mensile. Le richieste non riuscite o interrotte non vengono riavviate automaticamente.
Ogni modifica può restituire HTTP 202 quando un nuovo tentativo trova la stessa richiesta ancora in esecuzione, anche se la prima esecuzione è normalmente sincrona. Se l'esecuzione è completata ma resultStored è false, un nuovo tentativo restituisce HTTP 200 con lo stato della richiesta salvata anziché il risultato originale. Recupera l'output tramite l'azione di cronologia, risultato o download del relativo dominio.
## Esempi di richiesta
Sostituisci gli identificatori delle risorse e le chiavi multimediali di esempio con i valori restituiti per il tuo account. Mantieni stabile l'identificatore della richiesta quando ripeti la stessa modifica.
```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/segments_text_update' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","segmentIndex":0,"requestId":"41321bda-e243-4b6f-96a4-622cd047c991","source":"original","text":"Bienvenue au lancement de VoiceCheap."}'
```
```javascript JavaScript theme={null}
const input = {
projectId: 'project_launch_2026',
segmentIndex: 0,
requestId: '41321bda-e243-4b6f-96a4-622cd047c991',
source: 'original',
text: 'Bienvenue au lancement de VoiceCheap.',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segments_text_update', {
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_text_update",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "segmentIndex": 0, "requestId": "41321bda-e243-4b6f-96a4-622cd047c991", "source": "original", "text": "Bienvenue au lancement de VoiceCheap."},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```
## Risposta
Una prima esecuzione riuscita restituisce HTTP 200 con il risultato dell'operazione in data. Una ripetizione può invece restituire lo stato della richiesta salvata. L'esempio mostra una risposta supportata, non tutti i campi facoltativi.
Restituisce l'ammissione in coda e un'istantanea aggiornata della coda per una modifica del testo originale o tradotto.
```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": "text",
"segmentIndex": 0,
"source": "original"
},
"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_text_update",
"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_text_update",
"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"
}
```
## Campi del risultato
| Campo | Descrizione |
| - | - |
| `data.status` | started quando questo job è stato preso in carico o è iniziato; queued altrimenti. Nessuno dei due valori indica il completamento. |
| `data.jobId` | Identificatore del job in coda, uguale al requestId stabile di invio. |
| `data.queue` | Istantanea aggiornata della coda del progetto, che potrebbe già mostrare il job in stato running o in uno stato finale. |
| `data.queue.projectId` | Identificatore del progetto padre. |
| `data.queue.revision` | Revisione dell'istantanea della coda. È indipendente da projects\_get.segmentStructureRevision. |
| `data.queue.items` | Avanzamento delle azioni del progetto: identificatori dei processi, metadati delle azioni, stato, timestamp ed errorCode pubblico facoltativo. |
| `data.queue.items[].id` | Identificatore del job; corrisponde al requestId dell'invio originale in coda. |
| `data.queue.items[].action` | Solo metadati dell’azione: type, segmentIndex e, facoltativamente, workId, translatedVersionId e source. Il testo inviato, i valori temporali e le istruzioni di rigenerazione non vengono restituiti. |
| `data.queue.items[].status` | queued, running, completed, failed o cancelled. |
| `data.queue.items[].createdAt` | Ora di creazione dell'elemento in coda in millisecondi Unix. |
| `data.queue.items[].startedAt` | Ora opzionale del primo avvio in millisecondi Unix. |
| `data.queue.items[].finishedAt` | Ora opzionale di conclusione in millisecondi Unix. |
| `data.queue.items[].errorCode` | Codice di errore pubblico facoltativo. Gli errori non classificati usano ACTION\_FAILED. |
| `data.queue.items[].seenAt` | Ora facoltativa di conferma, solo per chi sta visualizzando il contenuto con autenticazione. |
## Recupera e monitora questa richiesta
Usa lo stesso identificatore anche dopo una connessione persa. Se resultStored è false, recupera l'output tramite la corrispondente azione di cronologia, risultato o download. Non avviare mai una seconda generazione solo per verificarne l'avanzamento.
```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_text_update"}'
```
```json HTTP 200 theme={null}
{
"data": {
"requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
"operation": "segments_text_update",
"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": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "queued",
"createdAt": 1792152000000
}
]
}
}
}
}
```
## Note sull'operazione
* Usa un unico requestId UUID v4 per la modifica prevista e riutilizzalo con argomenti identici nei nuovi tentativi. jobId corrisponde a questo requestId.
* L'ammissione restituisce started o queued, non il completamento. Interroga periodicamente segment\_actions\_list e individua items\[].id uguale a jobId fino a completed, failed o cancelled, quindi aggiorna transcripts\_get e projects\_get.
* queue.revision tiene traccia dello stato della coda; non è una revisione della struttura dei segmenti di origine. Le azioni in coda acquisiscono la struttura corrente al momento dell'ammissione. Una successiva modifica incompatibile della struttura può far fallire l'elemento con SEGMENT\_STRUCTURE\_CHANGED.
* È ammessa una sola azione in attesa per la stessa destinazione logica del segmento. Un nuovo requestId non aggira SEGMENT\_ACTION\_ALREADY\_PENDING.
* Gli errori di esecuzione della coda compaiono come items\[].status failed più errorCode, anziché modificare il risultato dell'invio riuscito.
* Per le modifiche all'originale, ometti workId ed enableEditing. Le modifiche al testo originale contrassegnano quel segmento come in attesa di traduzione in ogni lavoro linguistico; non generano automaticamente nuovo parlato.
* Per le modifiche alle traduzioni usa source translated e fornisci workId. Sono richieste entrambe le autorizzazioni transcription:write e translations:write.
* enableEditing è consentito solo per le modifiche alle traduzioni e attiva o disattiva esplicitamente la modalità di traduzione manuale. Una modifica alla traduzione aggiorna il testo e lo stato delle modifiche senza rigenerare il relativo audio vocale.
* Lo schema dell'azione consente una stringa di testo vuota. Usa l'azione dedicata segments\_delete per rimuovere un segmento e mantenere allineate tutte le lingue.
* Le risposte della coda, comprese quelle di invio, annullamento, polling e ripetizione, contengono solo metadati delle azioni. Legga il contenuto della trascrizione con transcripts\_get e l’autorizzazione richiesta transcription:read.
## Utilizzo
Ogni invocazione riuscita consuma una chiamata API/MCP mensile. Si applicano anche i crediti multimediali e le quote di generazione proprie dell'operazione.
## Errori
| Stato HTTP | Codice | Significato o risoluzione |
| - | - | - |
| 400 | `BAD_REQUEST` | L'indice del segmento di origine non esiste oppure gli argomenti della coda non sono validi. |
| 400 | `CREDENTIAL_IN_QUERY` | Le credenziali sono state fornite in un parametro di query access\_token o api\_key. Invia le credenziali negli header. |
| 400 | `IDEMPOTENCY_CONFLICT` | L'intestazione Idempotency-Key e il campo requestId del corpo devono coincidere. |
| 400 | `INVALID_REQUEST_ID` | Fornisci requestId o Idempotency-Key come UUID v4. |
| 400 | `SEGMENT_QUEUE_FULL` | Il progetto ha già 50 azioni sui segmenti in attesa. |
| 400 | `VALIDATION_ERROR` | Correggi l'input usando lo schema. I valori non validi o incoerenti vengono rifiutati prima dell'esecuzione. |
| 401 | `API_KEY_EXPIRED` | La chiave API è scaduta. |
| 401 | `INVALID_API_KEY` | Fornisci una chiave API valida e non scaduta. |
| 401 | `INVALID_CREDENTIAL` | L'header Authorization non è valido oppure è in conflitto con x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Non è stata fornita alcuna credenziale utilizzabile negli header, oppure la credenziale superava 4096 caratteri. |
| 401 | `USER_NOT_FOUND` | L'account associato alla credenziale non esiste più. |
| 403 | `ACCOUNT_UNAVAILABLE` | L'account che esegue l'azione o quello di fatturazione non è disponibile o è in fase di eliminazione. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | L'utente della credenziale appartiene a più di un team, quindi il contesto di fatturazione è ambiguo. |
| 403 | `FORBIDDEN` | L'utente chiamante autenticato non può accedere a questo progetto. |
| 403 | `INSUFFICIENT_SCOPE` | La modifica del testo tradotto richiede anche translations:write. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Impossibile verificare i limiti di integrazione dell'account. |
| 403 | `SUBSCRIPTION_REQUIRED` | Usa un abbonamento a pagamento attivo. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Non è stato possibile trovare l'account effettivo del proprietario del team. |
| 404 | `PROJECT_NOT_FOUND` | Il progetto non esiste nell'account accessibile. |
| 404 | `TRANSLATION_NOT_FOUND` | Il lavoro tradotto da modificare non appartiene a questo progetto. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Questo account ha già 10 azioni di integrazione in esecuzione. Interroga una richiesta esistente prima di avviarne un'altra. |
| 409 | `IDEMPOTENCY_CONFLICT` | Riutilizza un identificatore solo con la stessa operazione e gli stessi argomenti. |
| 409 | `SEGMENT_ACTION_ALREADY_PENDING` | Un'azione per lo stesso segmento logico di destinazione è già in coda o in esecuzione. |
| 409 | `SEGMENT_STRUCTURE_BUSY` | È in corso una modifica della struttura dei segmenti; ricarica il progetto prima di inviare nuovamente la richiesta. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Attendi il ripristino mensile o cambia piano. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Rispetta Retry-After quando presente e applica attese crescenti tra i tentativi. |
| 500 | `INTERNAL_ERROR` | Controlla lo stato della richiesta salvata e la cronologia delle risorse prima di decidere se ripetere una modifica. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | L'azione è stata eseguita ma non è stato possibile salvarne il risultato. Esamina lo stato della richiesta salvata e la cronologia delle risorse prima di avviare una nuova generazione. |
| 503 | `INTERNAL_ERROR` | La coda dei segmenti è disabilitata sul server di sviluppo; l'azione non è stata ammessa. |
| 503 | `SERVER_RESTARTING` | Il server si sta riavviando. Riprova tra poco e mantieni lo stesso identificatore della richiesta per una modifica. |
```json theme={null}
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["transcription:write"]
}
}
```
This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.