> ## 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. # Annulla un'azione sui segmenti in coda > Annulla una tua azione sui segmenti in attesa. Un'azione già in esecuzione non può essere annullata. Annulla una tua azione sui segmenti in attesa. Un'azione già in esecuzione non può essere annullata. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/segment_actions_cancel ``` ## 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: `translations: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 testuale. Formato: "uuid". Pattern: `^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$`. 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}$`. 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": "^[^/\\\\]+$" }, "jobId": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "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." } }, "required": ["projectId", "jobId"], "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/segment_actions_cancel' \ --header "x-api-key: $VOICECHEAP_API_KEY" \ --header 'Content-Type: application/json' \ --data '{"projectId":"project_launch_2026","jobId":"41321bda-e243-4b6f-96a4-622cd047c991","requestId":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}' ``` ```javascript JavaScript theme={null} const input = { projectId: 'project_launch_2026', jobId: '41321bda-e243-4b6f-96a4-622cd047c991', requestId: 'c6d1fec6-bf7d-40aa-91e7-e4b0676d6020', }; const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_cancel', { 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/segment_actions_cancel", headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]}, json={"projectId": "project_launch_2026", "jobId": "41321bda-e243-4b6f-96a4-622cd047c991", "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}, 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 lo snapshot completo e aggiornato della coda dopo l'annullamento di un'azione ancora in coda. ```json HTTP 200 theme={null} { "data": { "projectId": "project_launch_2026", "revision": 2, "items": [ { "id": "41321bda-e243-4b6f-96a4-622cd047c991", "action": { "type": "text", "segmentIndex": 0, "source": "original" }, "status": "cancelled", "createdAt": 1792152000000, "finishedAt": 1792152002000 } ] }, "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020" } ``` ```json HTTP 202 replay_running theme={null} { "data": { "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020", "operation": "segment_actions_cancel", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "running", "pollAfterSeconds": 5 }, "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020" } ``` ```json HTTP 200 replay_completed_without_result theme={null} { "data": { "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020", "operation": "segment_actions_cancel", "createdAt": 1792144800000, "updatedAt": 1792144820000, "status": "completed", "resultStored": false, "message": "The action completed. Retrieve its output from the corresponding history or resource action." }, "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020" } ``` ## Campi del risultato | Campo | Descrizione | | - | - | | `data.projectId` | Identificatore del progetto padre. | | `data.revision` | Revisione dell'istantanea della coda. È indipendente da projects\_get.segmentStructureRevision. | | `data.items` | Avanzamento delle azioni del progetto: identificatori dei processi, metadati delle azioni, stato, timestamp ed errorCode pubblico facoltativo. | | `data.items[].id` | Identificatore del job; corrisponde al requestId dell'invio originale in coda. | | `data.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.items[].status` | queued, running, completed, failed o cancelled. | | `data.items[].createdAt` | Ora di creazione dell'elemento in coda in millisecondi Unix. | | `data.items[].startedAt` | Ora opzionale del primo avvio in millisecondi Unix. | | `data.items[].finishedAt` | Ora opzionale di conclusione in millisecondi Unix. | | `data.items[].errorCode` | Codice di errore pubblico facoltativo. Gli errori non classificati usano ACTION\_FAILED. | | `data.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":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020","operation":"segment_actions_cancel"}' ``` ```json HTTP 200 theme={null} { "data": { "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020", "operation": "segment_actions_cancel", "status": "completed", "createdAt": 1792144800000, "updatedAt": 1792144820000, "resultStored": true, "result": { "projectId": "project_launch_2026", "revision": 2, "items": [ { "id": "41321bda-e243-4b6f-96a4-622cd047c991", "action": { "type": "text", "segmentIndex": 0, "source": "original" }, "status": "cancelled", "createdAt": 1792152000000, "finishedAt": 1792152002000 } ] } } } ``` ## Note sull'operazione * jobId identifica l'elemento della coda da annullare; requestId è un UUID v4 stabile separato per la richiesta di annullamento. * Solo un elemento queued può diventare cancelled. Gli elementi running, completed e failed non possono essere annullati. L'annullamento di un elemento già cancelled restituisce l'istantanea corrente. * Il gestore restituisce direttamente projectId, revision e items; non sono presenti un booleano success né un campo queue annidato. * Un annullamento non rimborsa la generazione completata e non interrompe l'elaborazione multimediale già in corso. * 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 | `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 | `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` | Concedi tutte le autorizzazioni richieste o scegli un'altra credenziale. | | 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 | `NOT_FOUND` | Nel progetto non esiste alcun elemento della coda con questo jobId. | | 404 | `PROJECT_NOT_FOUND` | Il progetto non esiste nell'account accessibile. | | 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 | `CONFLICT` | È possibile annullare solo le azioni in attesa; l'elemento è già iniziato o terminato. | | 409 | `IDEMPOTENCY_CONFLICT` | Riutilizza un identificatore solo con la stessa operazione e gli stessi argomenti. | | 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 | `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": ["translations:write"] } } ``` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.