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

# Een woordenlijst ophalen

> Haal de woordenlijstitems en toepassingsmodus voor een brontaal op. Teamleden hebben leestoegang tot de woordenlijst van de eigenaar.

Haal de woordenlijstitems en toepassingsmodus voor een brontaal op. Teamleden hebben leestoegang tot de woordenlijst van de eigenaar.

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/glossary_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: `glossary:read`.

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

## Parameters

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

  Minimale lengte: 2. Maximale lengte: 64.
</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": {
      "sourceLanguage": {
        "type": "string",
        "minLength": 2,
        "maxLength": 64
      }
    },
    "required": ["sourceLanguage"],
    "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/glossary_get' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"sourceLanguage":"english"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    sourceLanguage: 'english',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/glossary_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/glossary_get",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"sourceLanguage": "english"},
      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 woordenlijstinstellingen en openbare regels voor items van de brontaal.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "glossaryId": "user_123__english",
      "sourceLanguage": "english",
      "canWrite": true,
      "isActive": true,
      "defaultApplicationMode": "smart",
      "entryCount": 1,
      "entries": [
        {
          "entryId": "a8792157cb4f27fb949c035f45518c61e884bb86",
          "sourceText": "product",
          "targets": {
            "french": {
              "text": "Produit",
              "mode": "translate",
              "applicationMode": "smart"
            }
          },
          "createdAt": 1792065600000,
          "updatedAt": 1792152000000
        }
      ]
    }
  }
  ```
</ResponseExample>

## Resultaatvelden

| Veld | Beschrijving |
| - | - |
| `data.glossaryId` | Woordenlijst-ID voor de eigenaar van de werkruimte en de genormaliseerde brontaal. |
| `data.sourceLanguage` | Genormaliseerde naam van de brontaal. |
| `data.canWrite` | Of de aanroeper eigenaar is van deze woordenlijst en deze mag bewerken. |
| `data.isActive` | Huidige activeringsvlag van de woordenlijst; standaard true voor een woordenlijst die nog niet bestaat. |
| `data.defaultApplicationMode` | Standaardmodus smart of strict voor de woordenlijst. |
| `data.entryCount` | Opgeslagen aantal items, of het geladen aantal items als er geen opgeslagen aantal bestaat. |
| `data.entries` | Woordenlijstitems; een lege array als de woordenlijst nog niet bestaat. |
| `data.entries[].entryId` | ID van de opgeslagen vermelding. Deze kan veranderen wanneer de bronterm verandert. |
| `data.entries[].sourceText` | Bronterm die de woordenlijst retourneert, in kleine letters en zonder witruimte aan het begin en einde. |
| `data.entries[].targets` | Koppeling van genormaliseerde doeltaalnamen aan vertaalregels. |
| `data.entries[].targets.<language>.text` | Tekst die voor die doeltaal moet worden gebruikt. |
| `data.entries[].targets.<language>.mode` | translate of keep. |
| `data.entries[].targets.<language>.applicationMode` | smart of strict wanneer opgeslagen in de doelregel. |
| `data.entries[].createdAt` | Aanmaaktijdstip van het item in milliseconden, zoals geretourneerd door de opslagbewerking. |
| `data.entries[].updatedAt` | Opslagtijdstempel van de vermelding in milliseconden. |

## Opmerkingen bij de bewerking

* Een onbekende woordenlijst voor een ondersteunde brontaal retourneert de berekende glossaryId zonder items.
* Alleen de eigenaar kan de woordenlijst bewerken. Teamleden hebben leestoegang.

## 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 brontaal wordt niet ondersteund. |
| 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 | `FORBIDDEN` | De woordenlijst is niet beschikbaar voor het abonnement van de werkruimte. |
| 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": ["glossary:read"]
  }
}
```


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