> ## 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 un dossier

> Consultez le nom, les instructions de traduction, les identifiants de projets et, éventuellement, les métriques des projets d’un dossier dans votre espace de travail actif.

Consultez le nom, les instructions de traduction, les identifiants de projets et, éventuellement, les métriques des projets d’un dossier dans votre espace de travail actif.

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

## 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: `folders: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="folderId" type="string" required>
  Valeur textuelle.

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

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

  Valeur par défaut: false.
</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": {
      "folderId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/]+$"
      },
      "includeProjectMetrics": {
        "default": false,
        "type": "boolean"
      }
    },
    "required": ["folderId"],
    "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/folders_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"folderId":"624f6bb2-e06f-4353-8d6a-33d15f34c5c2","includeProjectMetrics":true}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    folderId: '624f6bb2-e06f-4353-8d6a-33d15f34c5c2',
    includeProjectMetrics: true,
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/folders_get', {
    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/folders_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2", "includeProjectMetrics": True},
      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 les détails du dossier, avec les métriques actuelles des projets lorsqu’elles sont demandées.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "folderId": "624f6bb2-e06f-4353-8d6a-33d15f34c5c2",
      "folderName": "Product videos",
      "projectIds": [
        "project_123"
      ],
      "dateCreated": 1792065600000,
      "translationInstructions": "Keep product names unchanged.",
      "projectMetrics": {
        "projectsCount": 1,
        "totalDurationSeconds": 120,
        "translatedProjectsCount": 1,
        "translationsInProgressProjectsCount": 0,
        "awaitingProofreadingProjectsCount": 0
      }
    }
  }
  ```
</ResponseExample>

## Champs du résultat

| Champ | Description |
| - | - |
| `data.folderId` | Identifiant du dossier. Utilisez la valeur renvoyée pour les actions suivantes sur le dossier. |
| `data.folderName` | Nom actuel du dossier. |
| `data.projectIds` | Identifiants des projets accessibles affectés à ce dossier. |
| `data.dateCreated` | Date de création du dossier sous forme d’horodatage Unix en millisecondes. |
| `data.translationInstructions` | Instructions de traduction enregistrées sur le dossier ; une chaîne vide signifie qu’il n’y en a aucune. |
| `data.projectMetrics` | Présent lorsque les métriques ont été demandées. |
| `data.projectMetrics.projectsCount` | Nombre de projets accessibles inclus dans projectIds. |
| `data.projectMetrics.totalDurationSeconds` | Durée totale des sources en secondes. |
| `data.projectMetrics.translatedProjectsCount` | Projets marqués comme traduits dans toutes leurs langues cibles. |
| `data.projectMetrics.translationsInProgressProjectsCount` | Projets dont les traductions sont en cours. |
| `data.projectMetrics.awaitingProofreadingProjectsCount` | Projets en attente de relecture. |

## Notes de l’opération

* includeProjectMetrics vaut false par défaut. Les métriques sont omises sauf si elles sont demandées.
* Pour les invités d’une équipe, projectIds et les métriques demandées incluent uniquement les projets qu’ils ont créés via l’API dans l’équipe active. Les résultats enregistrés et les rejeux appliquent les mêmes contrôles d’accès aux projets.

## 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` | Le dossier ou le compte d’espace de travail requis est introuvable. |
| 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` | L’objet JSON contient un champ non pris en charge, une valeur invalide ou un argument obligatoire manquant. |
| 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` | Le dossier n’appartient pas à l’espace de travail actif. |
| 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 | `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_MEMBERSHIP_INVALID` | L’appartenance actuelle du compte à une équipe ne correspond pas à l’espace de travail de cette connexion. Actualisez l’appartenance et reconnectez-vous. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Le compte du propriétaire effectif de l’équipe est introuvable. |
| 404 | `ACCOUNT_NOT_FOUND` | Le compte ou le compte de l’espace de travail actif est introuvable. |
| 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": ["folders:read"]
  }
}
```


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