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

# Consulter les actions de segment en file d’attente

> Suivez les actions d’édition ou de régénération de segments d’un projet, qu’elles soient en attente, en cours ou terminées.

Suivez les actions d’édition ou de régénération de segments d’un projet, qu’elles soient en attente, en cours ou terminées.

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

## 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: `projects:read`.

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>

<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": "^[^/\\\\]+$"
      }
    },
    "required": ["projectId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 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/segment_actions_list' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"projectId":"project_launch_2026"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    projectId: 'project_launch_2026',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_list', {
    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_list",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"projectId": "project_launch_2026"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## 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 la révision actuelle de la file d’attente du projet et les éléments d’action publics aux statuts queued et running, ainsi que ceux dans un état final.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "projectId": "project_launch_2026",
      "revision": 3,
      "items": [
        {
          "id": "41321bda-e243-4b6f-96a4-622cd047c991",
          "action": {
            "type": "text",
            "segmentIndex": 0,
            "source": "original"
          },
          "status": "completed",
          "createdAt": 1792152000000,
          "startedAt": 1792152001000,
          "finishedAt": 1792152002000
        }
      ]
    }
  }
  ```
</ResponseExample>

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

## Notes de l’opération

* Interrogez régulièrement items\[].id correspondant au jobId renvoyé par segments\_text\_update, segments\_timestamps\_update ou segments\_regenerate. completed, failed et cancelled sont des états terminaux.
* revision est la révision de la file, et non la valeur source segmentStructureRevision requise pour la suppression ou la fusion.
* Une action peut être soumise avec succès puis échouer dans la file d’attente. Consultez items\[].errorCode ; actualisez l’état du projet, de la transcription et des sorties concernés avant de décider d’une nouvelle action.
* Cette opération n’a aucun paramètre de pagination. Un projet sans file d’attente renvoie projectId, revision à 0 et un tableau items vide.
* 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 | `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 | `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. |
| 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 | `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": ["projects:read"]
  }
}
```


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