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

# Ordner abrufen

> Rufen Sie den Namen, die Übersetzungsanweisungen, die Projekt-IDs und optionale Projektkennzahlen eines Ordners in Ihrem aktiven Arbeitsbereich ab.

Rufen Sie den Namen, die Übersetzungsanweisungen, die Projekt-IDs und optionale Projektkennzahlen eines Ordners in Ihrem aktiven Arbeitsbereich ab.

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

## Authentifizierung und Berechtigungen

<ParamField header="x-api-key" type="string" required>
  Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt.
  OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.
</ParamField>

Erforderliche Berechtigungen: `folders:read`.

Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.

## Parameter

<ParamField body="folderId" type="string" required>
  Textwert.

  Mindestlänge: 1. Höchstlänge: 200. Muster: `^[^/]+$`.
</ParamField>

<ParamField body="includeProjectMetrics" type="boolean">
  Boolescher Wert.

  Standardwert: false.
</ParamField>

<Accordion title="Vollständiges Eingabeschema">
  Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "folderId": {
        "type": "string",
        "minLength": 1,
        "maxLength": 200,
        "pattern": "^[^/]+$"
      },
      "includeProjectMetrics": {
        "default": false,
        "type": "boolean"
      }
    },
    "required": ["folderId"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Anfragebeispiele

Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.

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

## Antwort

Eine erfolgreiche erste Ausführung gibt HTTP 200 mit dem Ergebnis der Operation unter data zurück. Bei einer Wiederholung kann stattdessen der gespeicherte Anfragestatus zurückgegeben werden. Das Beispiel zeigt eine unterstützte Antwort, nicht alle optionalen Felder.

Gibt Ordnerdetails zurück, auf Anfrage mit aktuellen Projektkennzahlen.

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

## Ergebnisfelder

| Feld | Beschreibung |
| - | - |
| `data.folderId` | Ordnerkennung. Verwenden Sie den zurückgegebenen Wert in nachfolgenden Ordneraktionen. |
| `data.folderName` | Aktueller Ordnername. |
| `data.projectIds` | Kennungen zugänglicher Projekte, die diesem Ordner zugeordnet sind. |
| `data.dateCreated` | Erstellungszeit des Ordners als Unix-Zeitstempel in Millisekunden. |
| `data.translationInstructions` | Am Ordner gespeicherte Übersetzungsanweisungen; eine leere Zeichenfolge bedeutet, dass keine vorhanden sind. |
| `data.projectMetrics` | Vorhanden, wenn Metriken angefordert wurden. |
| `data.projectMetrics.projectsCount` | Anzahl der zugänglichen Projekte in projectIds. |
| `data.projectMetrics.totalDurationSeconds` | Gesamtdauer der Quellen in Sekunden. |
| `data.projectMetrics.translatedProjectsCount` | Projekte, die in allen ihren Zielsprachen als übersetzt markiert sind. |
| `data.projectMetrics.translationsInProgressProjectsCount` | Projekte mit laufenden Übersetzungen. |
| `data.projectMetrics.awaitingProofreadingProjectsCount` | Projekte, die auf das Korrekturlesen warten. |

## Hinweise zur Operation

* includeProjectMetrics hat den Standardwert false. Metriken werden nur auf Anfrage ausgegeben.
* Bei Teamgästen enthalten projectIds und angeforderte Kennzahlen nur Projekte, die sie im aktiven Team über die API erstellt haben. Gespeicherte Ergebnisse und Wiederholungen wenden dieselben Projektzugriffsprüfungen an.

## Nutzung

Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.

## Fehler

| HTTP-Status | Code | Bedeutung oder Behebung |
| - | - | - |
| 400 | `BAD_REQUEST` | Der Ordner oder das erforderliche Arbeitsbereichskonto wurde nicht gefunden. |
| 400 | `CREDENTIAL_IN_QUERY` | Zugangsdaten wurden in einem Abfrageparameter namens access\_token oder api\_key übergeben. Senden Sie Zugangsdaten in Headern. |
| 400 | `VALIDATION_ERROR` | Das JSON-Objekt enthält ein nicht unterstütztes Feld, einen ungültigen Wert oder ein fehlendes erforderliches Argument. |
| 401 | `API_KEY_EXPIRED` | Der API-Schlüssel ist abgelaufen. |
| 401 | `INVALID_API_KEY` | Geben Sie einen gültigen, nicht abgelaufenen API-Schlüssel an. |
| 401 | `INVALID_CREDENTIAL` | Der Authorization-Header ist fehlerhaft oder steht im Konflikt mit x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Es wurde kein nutzbarer Berechtigungsnachweis im Header übergeben, oder er überschritt 4096 Zeichen. |
| 401 | `UNAUTHORIZED` | Der Ordner gehört nicht zum aktiven Arbeitsbereich. |
| 401 | `USER_NOT_FOUND` | Das Konto des Zugangsnachweises existiert nicht mehr. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | Der Benutzer des Berechtigungsnachweises gehört mehr als einem Team an, weshalb der Abrechnungskontext nicht eindeutig ist. |
| 403 | `INSUFFICIENT_SCOPE` | Erteilen Sie alle erforderlichen Berechtigungen oder verwenden Sie andere Zugangsdaten. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Die Integrationslimits des Kontos konnten nicht verifiziert werden. |
| 403 | `SUBSCRIPTION_REQUIRED` | Verwenden Sie ein aktives kostenpflichtiges Abonnement. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | Die aktuelle Teammitgliedschaft des Kontos stimmt nicht mit dem Arbeitsbereich dieser Verbindung überein. Aktualisieren Sie die Mitgliedschaft und stellen Sie die Verbindung erneut her. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Das maßgebliche Konto des Teaminhabers wurde nicht gefunden. |
| 404 | `ACCOUNT_NOT_FOUND` | Das Konto oder das Konto des aktiven Arbeitsbereichs wurde nicht gefunden. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Warten Sie auf die monatliche Zurücksetzung oder wechseln Sie den Tarif. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Warten Sie gegebenenfalls die in Retry-After angegebene Zeit und verwenden Sie zunehmend längere Warteintervalle. |
| 500 | `INTERNAL_ERROR` | Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen. |
| 503 | `SERVER_RESTARTING` | Der Server wird neu gestartet. Versuchen Sie es in Kürze erneut und behalten Sie bei einer Mutation dieselbe Anfragekennung bei. |

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