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

# Get a glossary

> Get the glossary entries and application mode for a source language. Team members have read access to the owner’s glossary.

Get the glossary entries and application mode for a source language. Team members have read access to the owner’s glossary.

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

## Authentication and permissions

<ParamField header="x-api-key" type="string" required>
  Send a VoiceCheap API key in this header. Authorization: Bearer with the same API key is also supported. OAuth access tokens are accepted only by
  MCP, not by this REST endpoint.
</ParamField>

Required permissions: `glossary:read`.

An active paid subscription is required. Permissions do not change team roles, resource ownership, media credits, or plan limits.

## Parameters

<ParamField body="sourceLanguage" type="string" required>
  Text value.

  Minimum length: 2. Maximum length: 64.
</ParamField>

<Accordion title="Complete input schema">
  The JSON Schema below preserves the exact field names, nested types, defaults, bounds, and accepted values exposed by discovery. Additional cross-field rules are listed in the operation notes.

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "sourceLanguage": {
        "type": "string",
        "minLength": 2,
        "maxLength": 64
      }
    },
    "required": ["sourceLanguage"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Request examples

Replace example resource identifiers and media keys with values returned for your account. Keep the request identifier stable when retrying the same mutation.

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

## Response

A successful first execution returns HTTP 200 with the operation result under data. A replay may return saved request state instead. The example shows one supported response, not every optional field.

Returns the source language’s glossary settings and public entry rules.

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

## Result fields

| Field | Description |
| - | - |
| `data.glossaryId` | Glossary identifier for the workspace owner and normalized source language. |
| `data.sourceLanguage` | Normalized source language name. |
| `data.canWrite` | Whether the caller owns this glossary and may edit it. |
| `data.isActive` | Current glossary activation flag; defaults to true for a glossary that does not yet exist. |
| `data.defaultApplicationMode` | smart or strict default mode for the glossary. |
| `data.entryCount` | Saved entry count, or the loaded entry count when no saved count exists. |
| `data.entries` | Glossary entries; an empty array when the glossary does not yet exist. |
| `data.entries[].entryId` | Identifier of the saved entry. It can change when the source term changes. |
| `data.entries[].sourceText` | Trimmed, lowercased source term returned by the glossary. |
| `data.entries[].targets` | Map from normalized target language names to translation rules. |
| `data.entries[].targets.<language>.text` | Text to use for that target language. |
| `data.entries[].targets.<language>.mode` | translate or keep. |
| `data.entries[].targets.<language>.applicationMode` | smart or strict when stored on the target rule. |
| `data.entries[].createdAt` | Entry creation timestamp in milliseconds as returned by the save operation. |
| `data.entries[].updatedAt` | Entry save timestamp in milliseconds. |

## Operation notes

* An unknown glossary for a supported source language returns its calculated glossaryId with no entries.
* Only the owner can edit the glossary. Team members have read access.

## Usage

Each successful invocation consumes one monthly API/MCP call. Media credits and the operation's own generation allowances also apply.

## Errors

| HTTP status | Code | Meaning or recovery |
| - | - | - |
| 400 | `BAD_REQUEST` | The source language is unsupported. |
| 400 | `CREDENTIAL_IN_QUERY` | Credentials were supplied in an access\_token or api\_key query parameter. Send credentials in headers. |
| 400 | `VALIDATION_ERROR` | The JSON object contains an unsupported field, an invalid value, or a missing required argument. |
| 401 | `API_KEY_EXPIRED` | The API key has expired. |
| 401 | `INVALID_API_KEY` | Provide a valid, unexpired API key. |
| 401 | `INVALID_CREDENTIAL` | The Authorization header is malformed or conflicts with x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No usable header credential was supplied, or it exceeded 4096 characters. |
| 401 | `USER_NOT_FOUND` | The credential's account no longer exists. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | The credential's user belongs to more than one team, so the billing context is ambiguous. |
| 403 | `FORBIDDEN` | The glossary is unavailable for the workspace’s plan. |
| 403 | `INSUFFICIENT_SCOPE` | Grant every required permission or choose another credential. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | The account's integration limits could not be verified. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use an active paid subscription. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | The account’s current team membership does not match this connection’s workspace. Refresh the membership and reconnect. |
| 403 | `TEAM_OWNER_NOT_FOUND` | The effective team owner account could not be found. |
| 404 | `ACCOUNT_NOT_FOUND` | The account or active workspace account could not be found. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Wait for the monthly reset or change plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Wait for Retry-After when present and use backoff. |
| 500 | `INTERNAL_ERROR` | Check saved request state and resource history before deciding to retry a mutation. |
| 503 | `SERVER_RESTARTING` | The server is restarting. Retry shortly and keep the same request identifier for a mutation. |

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