> ## 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.

# Ajouter des sous-titres dynamiques à une traduction

> Appliquez le modèle de sous-titres dynamiques sélectionné à une vidéo traduite ou avec synchronisation labiale terminée. Le quota habituel du forfait et les crédits média s’appliquent. Suivez l’avancement avec projects_get.

Appliquez le modèle de sous-titres dynamiques sélectionné à une vidéo traduite ou avec synchronisation labiale terminée. Le quota habituel du forfait et les crédits média s’appliquent. Suivez l’avancement avec projects\_get.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/subtitles_dynamic_create
```

## Authentification et autorisations

<ParamField header="x-api-key" type="string" required>
  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.
</ParamField>

Autorisations requises: `subtitles: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

<ParamField body="projectId" type="string" required>
  Valeur textuelle.

  Longueur minimale: 1. Longueur maximale: 200. Motif: `^[^/\\]+$`.
</ParamField>

<ParamField body="workId" type="string" required>
  Valeur textuelle.

  Longueur minimale: 1. Longueur maximale: 200. Motif: `^[^/\\]+$`.
</ParamField>

<ParamField body="translatedVersionId" type="string" required>
  Valeur textuelle.

  Longueur minimale: 1. Longueur maximale: 200. Motif: `^[^/\\]+$`.
</ParamField>

<ParamField body="templateName" type="string" required>
  Valeur textuelle.

  Valeurs acceptées: "Sara", "Daniel", "Dan 2", "Hormozi 4", "Dan", "Devin", "Tayo", "Ella", "Tracy", "Luke", "Hormozi 1", "Hormozi 2", "Hormozi 3", "Hormozi 5", "Leon", "Ali", "Beast", "Maya", "Karl", "Iman", "Umi", "David", "Noah", "Gstaad", "Malta", "Nema", "Seth", "William".
</ParamField>

<ParamField body="videoSource" type="string">
  Valeur textuelle.

  Valeurs acceptées: "translated", "lip-synced". Valeur par défaut: "translated".
</ParamField>

<ParamField body="magicZooms" type="boolean">
  Valeur booléenne.

  Valeur par défaut: false.
</ParamField>

<ParamField body="magicBrolls" type="boolean">
  Valeur booléenne.

  Valeur par défaut: false.
</ParamField>

<ParamField body="magicBrollsPercentage" type="number">
  Valeur numérique.

  Minimum: 0. Maximum: 100. Valeur par défaut: 0.
</ParamField>

<ParamField body="removeSilencePace" type="string">
  Valeur textuelle.

  Valeurs acceptées: "natural", "fast", "extra-fast".
</ParamField>

<ParamField body="removeBadTakes" type="boolean">
  Valeur booléenne.
</ParamField>

<ParamField body="requestId" type="string">
  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}$`.
</ParamField>

<Accordion title="Schéma d’entrée complet">
  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": "^[^/\\\\]+$"
      },
      "workId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      },
      "translatedVersionId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/\\\\]+$"
      },
      "templateName": {
        "type": "string",
        "enum": [
          "Sara",
          "Daniel",
          "Dan 2",
          "Hormozi 4",
          "Dan",
          "Devin",
          "Tayo",
          "Ella",
          "Tracy",
          "Luke",
          "Hormozi 1",
          "Hormozi 2",
          "Hormozi 3",
          "Hormozi 5",
          "Leon",
          "Ali",
          "Beast",
          "Maya",
          "Karl",
          "Iman",
          "Umi",
          "David",
          "Noah",
          "Gstaad",
          "Malta",
          "Nema",
          "Seth",
          "William"
        ]
      },
      "videoSource": {
        "default": "translated",
        "type": "string",
        "enum": ["translated", "lip-synced"]
      },
      "magicZooms": {
        "default": false,
        "type": "boolean"
      },
      "magicBrolls": {
        "default": false,
        "type": "boolean"
      },
      "magicBrollsPercentage": {
        "default": 0,
        "type": "number",
        "minimum": 0,
        "maximum": 100
      },
      "removeSilencePace": {
        "type": "string",
        "enum": ["natural", "fast", "extra-fast"]
      },
      "removeBadTakes": {
        "type": "boolean"
      },
      "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", "workId", "translatedVersionId", "templateName"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 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.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_dynamic_create' \
    --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","templateName":"Sara","videoSource":"translated","magicZooms":false,"magicBrolls":false,"magicBrollsPercentage":0,"requestId":"41321bda-e243-4b6f-96a4-622cd047c991"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_launch_2026',
    workId: '5f8423d1-e4c0-4f80-9e3f-eed959389e24',
    translatedVersionId: '0fa684f3-4997-4d7a-9424-16d1f9ac849c',
    templateName: 'Sara',
    videoSource: 'translated',
    magicZooms: false,
    magicBrolls: false,
    magicBrollsPercentage: 0,
    requestId: '41321bda-e243-4b6f-96a4-622cd047c991',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_dynamic_create', {
    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/subtitles_dynamic_create",
      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", "templateName": "Sara", "videoSource": "translated", "magicZooms": False, "magicBrolls": False, "magicBrollsPercentage": 0, "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## Réponse

Cette opération renvoie HTTP 202 pendant son exécution. Conservez requestId et interrogez action\_request\_get avec cet identifiant et le nom de l’opération d’origine. Les états de suivi sont running, completed, failed et interrupted. Un résultat terminé peut renvoyer vers une tâche média distincte ; poursuivez avec l’action de statut ou de résultat propre à l’opération.

Renvoie les identifiants du projet, du travail et de la version sélectionnés, avec le statut de traitement, après admission des sous-titres dynamiques.

<ResponseExample>
  ```json HTTP 202 theme={null}
  {
    "data": {
      "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "status": "running",
      "pollAction": "action_request_get",
      "pollAfterSeconds": 5
    },
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
  }
  ```

  ```json HTTP 200 theme={null}
  {
    "data": {
      "projectId": "project_launch_2026",
      "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
      "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
      "status": "processing"
    },
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
      "operation": "subtitles_dynamic_create",
      "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": "subtitles_dynamic_create",
      "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"
  }
  ```
</ResponseExample>

## Champs du résultat

| Champ | Description |
| - | - |
| `data.projectId` | Identifiant du projet parent. |
| `data.workId` | Identifiant du travail de traduction autorisé. |
| `data.translatedVersionId` | Version traduite finalisée sélectionnée. |
| `data.status` | processing après l’admission de la requête en aval ; la fin de la production de la sortie doit être suivie séparément par interrogations répétées. |

## 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":"41321bda-e243-4b6f-96a4-622cd047c991","operation":"subtitles_dynamic_create"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "41321bda-e243-4b6f-96a4-622cd047c991",
    "operation": "subtitles_dynamic_create",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "projectId": "project_launch_2026",
      "workId": "5f8423d1-e4c0-4f80-9e3f-eed959389e24",
      "translatedVersionId": "0fa684f3-4997-4d7a-9424-16d1f9ac849c",
      "status": "processing"
    }
  }
}
```

## Notes de l’opération

* templateName est un nom de modèle pris en charge. videoSource vaut translated par défaut ; lip-synced sélectionne la dernière vidéo de synchronisation labiale finalisée et enregistrée. Les URL média fournies par l’appelant ne sont pas acceptées.
* La version sélectionnée doit être finalisée et la vidéo sélectionnée doit être disponible. MP4 et MOV sont pris en charge ; la durée enregistrée du projet ne doit pas dépasser 2 heures et sa taille enregistrée ne doit pas dépasser 2 GiB.
* magicZooms et magicBrolls valent false par défaut ; magicBrollsPercentage vaut 0 par défaut. Le champ facultatif removeSilencePace accepte natural, fast ou extra-fast ; removeBadTakes est un booléen.
* La langue provient du travail de traduction autorisé. Les vérifications habituelles du quota de l’offre et des crédits média s’appliquent ; chaque traduction ne peut relancer les sous-titres dynamiques qu’une seule fois.
* Cette action prend du temps. Interrogez d’abord régulièrement action\_request\_get jusqu’à la fin du gestionnaire, puis projects\_get.translations\[].dynamicSubtitles pour obtenir inProgress, videoUrl et errorMessage. projects\_status n’expose pas cet état des sous-titres dynamiques.

## 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 | `BAD_REQUEST` | La version ou la vidéo sélectionnée n’est pas prête, son format ou sa taille n’est pas pris en charge, ou les crédits média disponibles sont insuffisants. |
| 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 | `UNAUTHORIZED` | Une génération est déjà en cours, la limite d’une seule réexécution est atteinte ou le quota de l’offre est épuisé. |
| 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 | `PROJECT_NOT_FOUND` | Le projet n’existe pas dans le compte accessible. |
| 404 | `TRANSLATION_NOT_FOUND` | workId n’identifie pas un travail de traduction appartenant à ce projet. |
| 404 | `TRANSLATION_VERSION_NOT_FOUND` | translatedVersionId n’appartient pas au travail de traduction sélectionné. |
| 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` | La vidéo sélectionnée a changé avant l’admission de la génération. |
| 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": ["subtitles:write"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.