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

# Consultar um glossário

> Consulte as entradas do glossário e o modo de aplicação para um idioma de origem. Os membros da equipe têm acesso de leitura ao glossário do proprietário.

Consulte as entradas do glossário e o modo de aplicação para um idioma de origem. Os membros da equipe têm acesso de leitura ao glossário do proprietário.

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

## Autenticação e permissões

**x-api-key** `string` *required*

Envie uma chave de API VoiceCheap neste cabeçalho. Authorization: Bearer com a mesma chave de API também é aceito. Tokens de acesso OAuth são
aceitos apenas pelo MCP, não por este endpoint REST.

Permissões necessárias: `glossary:read`.

É necessária uma assinatura paga ativa. As permissões não alteram funções na equipe, propriedade dos recursos, créditos de mídia ou limites do plano.

## Parâmetros

**sourceLanguage** `string` *required*

Valor de texto.

Comprimento mínimo: 2. Comprimento máximo: 64.

> [accordion] Esquema de entrada completo
>
> O JSON Schema abaixo preserva os nomes exatos dos campos, tipos aninhados, valores padrão, limites e valores aceitos expostos pela descoberta. Regras adicionais entre campos são listadas nas notas da operação.
>
> ```json theme={null}
> {
>   "type": "object",
>   "properties": {
>     "sourceLanguage": {
>       "type": "string",
>       "minLength": 2,
>       "maxLength": 64
>     }
>   },
>   "required": ["sourceLanguage"],
>   "additionalProperties": false
> }
> ```

## Exemplos de requisição

Substitua os identificadores de recursos e as chaves de mídia dos exemplos pelos valores retornados para sua conta. Mantenha o identificador da requisição ao tentar novamente a mesma alteração.

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

## Resposta

Uma primeira execução bem-sucedida retorna HTTP 200 com o resultado da operação em data. Uma repetição pode retornar o estado salvo da requisição. O exemplo mostra uma resposta aceita, não todos os campos opcionais.

Retorna as configurações do glossário do idioma de origem e as regras públicas das entradas.

```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
      }
    ]
  }
}
```

## Campos do resultado

| Campo | Descrição |
| - | - |
| `data.glossaryId` | Identificador do glossário para o proprietário do espaço de trabalho e o idioma de origem normalizado. |
| `data.sourceLanguage` | Nome normalizado do idioma de origem. |
| `data.canWrite` | Indica se o chamador é proprietário deste glossário e pode editá-lo. |
| `data.isActive` | Indicador atual de ativação do glossário; o padrão é true para um glossário que ainda não existe. |
| `data.defaultApplicationMode` | Modo padrão smart ou strict para o glossário. |
| `data.entryCount` | Contagem de entradas salva, ou a contagem de entradas carregadas quando não existe uma contagem salva. |
| `data.entries` | Entradas do glossário; um array vazio quando o glossário ainda não existe. |
| `data.entries[].entryId` | Identificador da entrada salva. Pode mudar quando o termo de origem muda. |
| `data.entries[].sourceText` | Termo de origem retornado pelo glossário, em minúsculas e sem espaços nas extremidades. |
| `data.entries[].targets` | Mapeamento de nomes normalizados de idiomas de destino para regras de tradução. |
| `data.entries[].targets.<language>.text` | Texto a usar nesse idioma de destino. |
| `data.entries[].targets.<language>.mode` | translate ou keep. |
| `data.entries[].targets.<language>.applicationMode` | smart ou strict quando armazenado na regra de destino. |
| `data.entries[].createdAt` | Timestamp de criação da entrada em milissegundos, conforme retornado pela operação de salvamento. |
| `data.entries[].updatedAt` | Timestamp de salvamento da entrada em milissegundos. |

## Notas da operação

* Um glossário desconhecido para um idioma de origem compatível retorna seu glossaryId calculado sem entradas.
* Somente o proprietário pode editar o glossário. Os membros da equipe têm acesso de leitura.

## Uso

Cada chamada bem-sucedida consome uma chamada mensal da API/MCP. Os créditos de mídia e as cotas de geração da própria operação também se aplicam.

## Erros

| Status HTTP | Código | Significado ou recuperação |
| - | - | - |
| 400 | `BAD_REQUEST` | O idioma de origem não é compatível. |
| 400 | `CREDENTIAL_IN_QUERY` | Foram fornecidas credenciais em um parâmetro de consulta access\_token ou api\_key. Envie as credenciais nos cabeçalhos. |
| 400 | `VALIDATION_ERROR` | O objeto JSON contém um campo não compatível, um valor inválido ou um argumento obrigatório ausente. |
| 401 | `API_KEY_EXPIRED` | A chave de API expirou. |
| 401 | `INVALID_API_KEY` | Forneça uma chave de API válida e dentro do prazo de validade. |
| 401 | `INVALID_CREDENTIAL` | O cabeçalho Authorization está malformado ou entra em conflito com x-api-key. |
| 401 | `MISSING_CREDENTIAL` | Nenhuma credencial utilizável foi fornecida no cabeçalho, ou ela excedeu 4096 caracteres. |
| 401 | `USER_NOT_FOUND` | A conta da credencial não existe mais. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | O usuário da credencial pertence a mais de uma equipe, portanto o contexto de cobrança é ambíguo. |
| 403 | `FORBIDDEN` | O glossário está indisponível para o plano do espaço de trabalho. |
| 403 | `INSUFFICIENT_SCOPE` | Conceda todas as permissões necessárias ou escolha outra credencial. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | Não foi possível verificar os limites de integração da conta. |
| 403 | `SUBSCRIPTION_REQUIRED` | Use uma assinatura paga ativa. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | O vínculo atual da conta com a equipe não corresponde ao espaço de trabalho desta conexão. Atualize o vínculo de membro e reconecte. |
| 403 | `TEAM_OWNER_NOT_FOUND` | Não foi possível encontrar a conta efetiva do proprietário da equipe. |
| 404 | `ACCOUNT_NOT_FOUND` | Não foi possível encontrar a conta ou a conta do espaço de trabalho ativo. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Aguarde a renovação do limite mensal ou mude de plano. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Aguarde o prazo de Retry-After, quando presente, e aumente progressivamente o intervalo entre as tentativas. |
| 500 | `INTERNAL_ERROR` | Verifique o estado da requisição salva e o histórico do recurso antes de decidir repetir uma alteração. |
| 503 | `SERVER_RESTARTING` | O servidor está reiniciando. Tente novamente em breve e mantenha o mesmo identificador de requisição para uma alteração. |

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