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

# Verbruiksverloop van een vertaling ophalen

> Haal levenscyclusgebeurtenissen voor afschrijvingen, terugboekingen, vertaling en lipsynchronisatie van een vertaalde versie in je werkruimte op.

Haal levenscyclusgebeurtenissen voor afschrijvingen, terugboekingen, vertaling en lipsynchronisatie van een vertaalde versie in je werkruimte op.

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

## Authenticatie en machtigingen

<ParamField header="x-api-key" type="string" required>
  Stuur een VoiceCheap API-sleutel mee in deze header. Authorization: Bearer met dezelfde API-sleutel wordt ook ondersteund. OAuth-toegangstokens
  worden alleen door MCP geaccepteerd, niet door dit REST-endpoint.
</ParamField>

Vereiste machtigingen: `usage:read`.

Een actief betaald abonnement is vereist. Machtigingen wijzigen geen teamrollen, eigendom van resources, mediategoed of abonnementslimieten.

## Parameters

<ParamField body="translatedVersionId" type="string" required>
  Tekstwaarde.

  Minimale lengte: 1. Maximale lengte: 200. Patroon: `^[^/]+$`.
</ParamField>

<Accordion title="Volledig invoerschema">
  Het onderstaande JSON Schema behoudt de exacte veldnamen, geneste typen, standaardwaarden, grenzen en toegestane waarden die discovery beschikbaar stelt. Aanvullende regels tussen velden staan in de opmerkingen bij de bewerking.

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

## Voorbeeldaanvragen

Vervang de voorbeeldidentificaties van resources en mediasleutels door waarden die voor je account zijn geretourneerd. Behoud dezelfde aanvraagidentificatie wanneer je dezelfde wijziging opnieuw probeert.

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/usage_translation_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"translatedVersionId":"version_123"}'
  ```

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

## Antwoord

Een geslaagde eerste uitvoering retourneert HTTP 200 met het resultaat van de bewerking onder data. Een herhaalde aanvraag kan in plaats daarvan de opgeslagen aanvraagstatus retourneren. Het voorbeeld toont één ondersteund antwoord, niet alle optionele velden.

Retourneert de openbare facturerings- en verwerkingslevenscyclus van één vertaalversie in de actieve werkruimte.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "kind": "translation",
      "isHistoricalDerived": false,
      "summary": {
        "title": "Product launch",
        "sourceLanguage": "English",
        "targetLanguage": "french",
        "translationStatus": "completed",
        "lipSyncStatus": "not_used",
        "totals": {
          "translationBaseMinutes": 2,
          "lipSyncExtraMinutes": 0,
          "lipSyncProExtraMinutes": 0,
          "lipSyncPro2ExtraMinutes": 0,
          "totalChargedMinutes": 2,
          "refundedMinutes": 0,
          "netUsedMinutes": 2
        }
      },
      "events": [
        {
          "id": "version_123-project-created",
          "type": "project_created",
          "timestamp": 1792065540000,
          "tone": "neutral"
        },
        {
          "id": "version_123-translation-launched",
          "type": "translation_launched",
          "timestamp": 1792065600000,
          "tone": "neutral",
          "minuteDelta": 2
        },
        {
          "id": "version_123-translation-completed",
          "type": "translation_completed",
          "timestamp": 1792065720000,
          "tone": "success",
          "isDerived": false
        }
      ]
    }
  }
  ```
</ResponseExample>

## Resultaatvelden

| Veld | Beschrijving |
| - | - |
| `data.kind` | translation of project. |
| `data.isHistoricalDerived` | Of één of meer verbruiksgegevens zijn afgeleid van historische gegevens. |
| `data.summary.title` | Weergavenaam van het project. |
| `data.summary.sourceLanguage` | Opgemaakt brontaallabel, indien beschikbaar. |
| `data.summary.targetLanguage` | Doeltaal voor een vertaallevenscyclus; ontbreekt bij een projectlevenscyclus. |
| `data.summary.translationStatus` | Vertaalstatus voor een vertaallevenscyclus; weggelaten bij een projectlevenscyclus. |
| `data.summary.lipSyncStatus` | Lipsynchronisatiestatus voor een vertaallifecycle; weggelaten bij een projectlifecycle. |
| `data.summary.totals.translationBaseMinutes` | In rekening gebrachte basisvertaalminuten over de overeenkomende rijen. |
| `data.summary.totals.lipSyncExtraMinutes` | Extra in rekening gebrachte minuten voor Standard-lipsynchronisatie. |
| `data.summary.totals.lipSyncProExtraMinutes` | Extra in rekening gebrachte Pro-minuten voor lipsynchronisatie. |
| `data.summary.totals.lipSyncPro2ExtraMinutes` | Extra afgeschreven minuten voor Pro 2-lipsynchronisatie. |
| `data.summary.totals.totalChargedMinutes` | Totaal afgeschreven minuten vóór terugboekingen. |
| `data.summary.totals.refundedMinutes` | Teruggeboekte minuten. |
| `data.summary.totals.netUsedMinutes` | Afgeschreven minuten minus teruggeboekte minuten. |
| `data.events` | Levenscyclusgebeurtenissen op volgorde van tijdstempel; gebeurtenissen zonder tijdstempel volgen na gebeurtenissen met een tijdstempel. |
| `data.events[].id` | Stabiele gebeurtenisidentificatie voor de gerapporteerde levenscyclusstap. |
| `data.events[].type` | Gebeurtenistype zoals project\_created, translation\_launched, translation\_completed of lip\_sync\_refunded. |
| `data.events[].timestamp` | Optioneel gebeurtenistijdstempel in milliseconden. |
| `data.events[].tone` | neutral, success, warning of danger. |
| `data.events[].relatedRunLabel` | Optioneel label met doeltaal en uitvoering voor levenscyclusgebeurtenissen van het project. |
| `data.events[].minuteDelta` | Optionele afgeschreven minuten als positief getal of teruggeboekte minuten als negatief getal. |
| `data.events[].isDerived` | Optionele vlag die aangeeft dat een gebeurtenis is gereconstrueerd uit historische gegevens. |

## Opmerkingen bij de bewerking

* De versie moet bij de actieve werkruimte horen.
* Het antwoord laat ruwe verwerkingsfoutmeldingen en weergavelabels van gebeurtenissen weg. Gebruik het gebeurtenistype om de levenscyclus te interpreteren.
* Tijdstempels en afleidingsvlaggen kunnen bij historische gebeurtenissen ontbreken.

## Verbruik

Elke geslaagde aanroep verbruikt één maandelijkse API/MCP-aanroep. Ook het mediategoed en de eigen generatielimieten van de bewerking zijn van toepassing.

## Fouten

| HTTP-status | Code | Betekenis of herstel |
| - | - | - |
| 400 | `BAD_REQUEST` | De vertaalde versie kon niet worden gevonden in de actieve werkruimte. |
| 400 | `CREDENTIAL_IN_QUERY` | Inloggegevens zijn opgegeven in een queryparameter access\_token of api\_key. Stuur inloggegevens in headers. |
| 400 | `VALIDATION_ERROR` | Het JSON-object bevat een niet-ondersteund veld, een ongeldige waarde of een ontbrekend verplicht argument. |
| 401 | `API_KEY_EXPIRED` | De API-sleutel is verlopen. |
| 401 | `INVALID_API_KEY` | Geef een geldige, niet-verlopen API-sleutel op. |
| 401 | `INVALID_CREDENTIAL` | De Authorization-header heeft een ongeldige indeling of is in strijd met x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Er is geen bruikbaar authenticatiemiddel in de header opgegeven, of het overschreed 4096 tekens. |
| 401 | `USER_NOT_FOUND` | Het account dat bij de toegangsgegevens hoort, bestaat niet meer. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | De gebruiker van het authenticatiemiddel behoort tot meer dan één team, waardoor de factureringscontext onduidelijk is. |
| 403 | `INSUFFICIENT_SCOPE` | Verleen alle vereiste machtigingen of kies andere toegangsgegevens. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | De integratielimieten van het account konden niet worden geverifieerd. |
| 403 | `SUBSCRIPTION_REQUIRED` | Gebruik een actief betaald abonnement. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | Het huidige teamlidmaatschap van het account komt niet overeen met de werkruimte van deze verbinding. Vernieuw het lidmaatschap en maak opnieuw verbinding. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Het effectieve account van de teameigenaar kon niet worden gevonden. |
| 404 | `ACCOUNT_NOT_FOUND` | Het account of het account van de actieve werkruimte kon niet worden gevonden. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wacht tot de maandelijkse reset of wijzig je abonnement. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wacht de tijd uit Retry-After af wanneer deze aanwezig is en vergroot de wachttijd tussen nieuwe pogingen. |
| 500 | `INTERNAL_ERROR` | Controleer de opgeslagen aanvraagstatus en de resourcegeschiedenis voordat je besluit een wijziging opnieuw te proberen. |
| 503 | `SERVER_RESTARTING` | De server wordt opnieuw gestart. Probeer het zo opnieuw en behoud bij een wijziging dezelfde aanvraagidentificatie. |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["usage:read"]
  }
}
```


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