> ## 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.
# Annuler une action de segment en attente
> Annulez votre action de segment en attente. Une action déjà en cours d’exécution ne peut pas être annulée.
Annulez votre action de segment en attente. Une action déjà en cours d’exécution ne peut pas être annulée.
```http theme={null}
POST https://api.voicecheap.ai/v1/actions/segment_actions_cancel
```
## Authentification et autorisations
Envoyez une clé API VoiceCheap dans cet en-tête. Authorization: Bearer avec la même clé API est également accepté. Les jetons d’accès OAuth sont
acceptés uniquement par MCP, pas par cet endpoint REST.
Autorisations requises: `translations:write`.
Un abonnement payant actif est requis. Les autorisations ne modifient ni les rôles dans l’équipe, ni la propriété des ressources, ni les crédits média, ni les limites du forfait.
## Paramètres
Valeur textuelle.
Longueur minimale: 1. Longueur maximale: 200. Motif: `^[^/\\]+$`.
Valeur textuelle.
Format: "uuid". Motif: `^([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)$`.
Facultatif au niveau du transport : le serveur injecte un identifiant avant la validation si ce champ est omis. Fournissez votre propre UUID v4 stable pour récupérer le résultat en toute sécurité si la réponse est perdue.
Format: "uuid". Motif: `^[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}$`.
Le JSON Schema ci-dessous conserve les noms de champs exacts, les types imbriqués, les valeurs par défaut, les limites et les valeurs acceptées exposés par la découverte. Les règles supplémentaires entre champs figurent dans les notes de l’opération.
```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
}
```
## Idempotence
Utilisez un UUID v4 dans requestId ou dans l’en-tête HTTP Idempotency-Key pour chaque mutation. Après une erreur réseau, réutilisez le même identifiant avec des arguments identiques. Si les deux sont fournis, ils doivent correspondre. Rejouer une requête enregistrée ne répète pas l’opération et ne décompte pas un nouvel appel mensuel. Les requêtes en échec ou interrompues ne sont pas relancées automatiquement.
Toute mutation peut renvoyer HTTP 202 lorsqu’une nouvelle tentative retrouve la même requête encore en cours, même si sa première exécution est habituellement synchrone. Si l’exécution est terminée mais que resultStored vaut false, une nouvelle tentative renvoie HTTP 200 avec l’état de la requête enregistrée, au lieu du résultat d’origine. Récupérez le résultat avec l’action d’historique, de résultat ou de téléchargement de son domaine.
## Exemples de requêtes
Remplacez les exemples d’identifiants de ressources et de clés média par des valeurs renvoyées pour votre compte. Conservez le même identifiant de requête lorsque vous réessayez la même mutation.
```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)
```
## Réponse
Une première exécution réussie renvoie HTTP 200 avec le résultat de l’opération sous data. Une nouvelle tentative peut renvoyer à la place l’état de la requête enregistrée. L’exemple présente une réponse possible, sans tous les champs facultatifs.
Renvoie l’état complet et actualisé de la file après l’annulation d’une action encore en attente.
```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"
}
```
## Champs du résultat
| Champ | Description |
| - | - |
| `data.projectId` | Identifiant du projet parent. |
| `data.revision` | Révision de l’instantané de la file d’attente. Elle est indépendante de projects\_get.segmentStructureRevision. |
| `data.items` | Progression des actions du projet : identifiants des tâches, métadonnées des actions, état, horodatages et errorCode public facultatif. |
| `data.items[].id` | Identifiant de la tâche ; égal au requestId d’origine de la soumission à la file d’attente. |
| `data.items[].action` | Métadonnées de l’action uniquement : type, segmentIndex et, facultativement, workId, translatedVersionId et source. Le texte envoyé, les valeurs de synchronisation et les instructions de régénération ne sont pas renvoyés. |
| `data.items[].status` | queued, running, completed, failed ou cancelled. |
| `data.items[].createdAt` | Date de création de l’élément de la file en millisecondes Unix. |
| `data.items[].startedAt` | Date du premier démarrage, facultative, en millisecondes Unix. |
| `data.items[].finishedAt` | Date de passage à un état final, facultative, en millisecondes Unix. |
| `data.items[].errorCode` | Code d’échec public facultatif. Les échecs non classés utilisent ACTION\_FAILED. |
| `data.items[].seenAt` | Date d’accusé de réception facultative, uniquement pour l’utilisateur authentifié qui consulte le résultat. |
## Récupérer et suivre cette requête
Utilisez le même identifiant, même après une perte de connexion. Si resultStored vaut false, récupérez le résultat avec l’action d’historique, de résultat ou de téléchargement correspondante. Ne lancez jamais une seconde génération uniquement pour vérifier l’avancement.
```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
}
]
}
}
}
```
## Notes de l’opération
* jobId identifie l’élément de file d’attente à annuler ; requestId est un UUID v4 stable distinct pour la requête d’annulation.
* Seul un élément au statut queued peut passer à cancelled. Les éléments aux statuts running, completed et failed ne peuvent pas être annulés. L’annulation d’un élément déjà annulé renvoie l’instantané actuel.
* Le gestionnaire renvoie directement projectId, revision et items ; il n’y a pas de booléen success ni de champ queue imbriqué.
* Une annulation ne rembourse pas une génération terminée et n’arrête pas un traitement média déjà en cours.
* Les réponses de la file, y compris lors de la soumission, de l’annulation, du suivi et du rejeu, contiennent uniquement les métadonnées des actions. Consultez le contenu de la transcription avec transcripts\_get et la permission requise transcription:read.
## Utilisation
Chaque invocation réussie consomme un appel du quota mensuel API/MCP. Les crédits média et les quotas de génération propres à l’opération s’appliquent également.
## Erreurs
| Statut HTTP | Code | Signification ou solution |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | Des identifiants ont été fournis dans un paramètre de requête access\_token ou api\_key. Envoyez les identifiants dans les en-têtes. |
| 400 | `IDEMPOTENCY_CONFLICT` | L’en-tête Idempotency-Key et le champ requestId du corps doivent correspondre. |
| 400 | `INVALID_REQUEST_ID` | Fournissez un UUID v4 dans requestId ou Idempotency-Key. |
| 400 | `VALIDATION_ERROR` | Corrigez l’entrée à l’aide du schéma. Les valeurs invalides ou incohérentes sont refusées avant l’exécution. |
| 401 | `API_KEY_EXPIRED` | La clé API a expiré. |
| 401 | `INVALID_API_KEY` | Fournissez une clé API valide et non expirée. |
| 401 | `INVALID_CREDENTIAL` | L’en-tête Authorization est mal formé ou entre en conflit avec x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Aucun identifiant d’authentification utilisable n’a été fourni dans les en-têtes, ou il dépassait 4096 caractères. |
| 401 | `USER_NOT_FOUND` | Le compte associé à l’identifiant d’accès n’existe plus. |
| 403 | `ACCOUNT_UNAVAILABLE` | Le compte à l’origine de l’action ou le compte de facturation est indisponible ou en cours de suppression. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | L’utilisateur associé aux identifiants d’authentification appartient à plusieurs équipes, ce qui rend le contexte de facturation ambigu. |
| 403 | `FORBIDDEN` | L’appelant authentifié ne peut pas accéder à ce projet. |
| 403 | `INSUFFICIENT_SCOPE` | Accordez toutes les autorisations requises ou choisissez d’autres identifiants d’accès. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Les limites d’intégration du compte n’ont pas pu être vérifiées. |
| 403 | `SUBSCRIPTION_REQUIRED` | Utilisez un abonnement payant actif. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Le compte du propriétaire effectif de l’équipe est introuvable. |
| 404 | `NOT_FOUND` | Aucun élément de file d’attente avec ce jobId n’existe dans le projet. |
| 404 | `PROJECT_NOT_FOUND` | Le projet n’existe pas dans le compte accessible. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Ce compte a déjà 10 actions d’intégration en cours. Suivez une requête existante avant d’en démarrer une autre. |
| 409 | `CONFLICT` | Seules les actions en attente peuvent être annulées ; cet élément a déjà commencé ou est terminé. |
| 409 | `IDEMPOTENCY_CONFLICT` | Réutilisez un identifiant uniquement avec la même opération et les mêmes arguments. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Attendez la réinitialisation mensuelle ou changez de forfait. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Respectez Retry-After lorsqu’il est présent et espacez progressivement les nouvelles tentatives. |
| 500 | `INTERNAL_ERROR` | Vérifiez l’état de la requête enregistrée et l’historique de la ressource avant de décider de réessayer une mutation. |
| 503 | `ACTION_RESULT_UNAVAILABLE` | L’action a été exécutée, mais son résultat n’a pas pu être enregistré. Consultez l’état de la requête enregistrée et l’historique de la ressource avant de lancer une nouvelle génération. |
| 503 | `SERVER_RESTARTING` | Le serveur redémarre. Réessayez dans un instant en conservant le même identifiant de requête pour une mutation. |
```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.