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

# Obtener un glosario

> Obtén las entradas del glosario y su modo de aplicación para un idioma de origen. Los miembros del equipo tienen acceso de lectura al glosario del propietario.

Obtén las entradas del glosario y su modo de aplicación para un idioma de origen. Los miembros del equipo tienen acceso de lectura al glosario del propietario.

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

## Autenticación y permisos

<ParamField header="x-api-key" type="string" required>
  Envía una clave de API de VoiceCheap en esta cabecera. También se admite Authorization: Bearer con la misma clave de API. Los tokens de acceso OAuth
  solo se aceptan en MCP, no en este endpoint REST.
</ParamField>

Permisos necesarios: `glossary:read`.

Se requiere una suscripción de pago activa. Los permisos no cambian los roles del equipo, la propiedad de los recursos, los créditos multimedia ni los límites del plan.

## Parámetros

<ParamField body="sourceLanguage" type="string" required>
  Valor de texto.

  Longitud mínima: 2. Longitud máxima: 64.
</ParamField>

<Accordion title="Esquema completo de entrada">
  El JSON Schema siguiente conserva los nombres exactos de los campos, los tipos anidados, los valores predeterminados, los límites y los valores aceptados que expone el descubrimiento. Las reglas adicionales entre campos se indican en las notas de la operación.

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

## Ejemplos de solicitud

Sustituye los identificadores de recursos y las claves multimedia de los ejemplos por valores devueltos para tu cuenta. Mantén el identificador de solicitud al reintentar la misma modificación.

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

## Respuesta

Una primera ejecución correcta devuelve HTTP 200 con el resultado de la operación en data. Una repetición puede devolver el estado de la solicitud guardada en su lugar. El ejemplo muestra una respuesta admitida, no todos los campos opcionales.

Devuelve los ajustes del glosario del idioma de origen y las reglas públicas de las entradas.

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

## Campos del resultado

| Campo | Descripción |
| - | - |
| `data.glossaryId` | Identificador del glosario para el propietario del espacio de trabajo y el idioma de origen normalizado. |
| `data.sourceLanguage` | Nombre normalizado del idioma de origen. |
| `data.canWrite` | Indica si quien llama es propietario de este glosario y puede editarlo. |
| `data.isActive` | Indicador de activación actual del glosario; el valor predeterminado es true para un glosario que aún no existe. |
| `data.defaultApplicationMode` | Modo predeterminado smart o strict del glosario. |
| `data.entryCount` | Número de entradas guardado, o número de entradas cargadas cuando no hay un recuento guardado. |
| `data.entries` | Entradas del glosario; un array vacío si el glosario aún no existe. |
| `data.entries[].entryId` | Identificador de la entrada guardada. Puede cambiar cuando cambia el término de origen. |
| `data.entries[].sourceText` | Término de origen devuelto por el glosario, en minúsculas y sin espacios en los extremos. |
| `data.entries[].targets` | Mapa de nombres normalizados de idiomas de destino a reglas de traducción. |
| `data.entries[].targets.<language>.text` | Texto que se usará para ese idioma de destino. |
| `data.entries[].targets.<language>.mode` | translate o keep. |
| `data.entries[].targets.<language>.applicationMode` | smart o strict cuando se almacena en la regla de destino. |
| `data.entries[].createdAt` | Marca de tiempo de creación de la entrada en milisegundos, tal como la devuelve la operación de guardado. |
| `data.entries[].updatedAt` | Marca de tiempo de guardado de la entrada en milisegundos. |

## Notas de la operación

* Un glosario desconocido para un idioma de origen compatible devuelve su glossaryId calculado sin entradas.
* Solo el propietario puede editar el glosario. Los miembros del equipo tienen acceso de lectura.

## Uso

Cada invocación correcta consume una llamada mensual de API/MCP. También se aplican los créditos multimedia y las cuotas de generación propias de la operación.

## Errores

| Estado HTTP | Código | Significado o solución |
| - | - | - |
| 400 | `BAD_REQUEST` | El idioma de origen no es compatible. |
| 400 | `CREDENTIAL_IN_QUERY` | Se han proporcionado credenciales en un parámetro de consulta access\_token o api\_key. Envía las credenciales en las cabeceras. |
| 400 | `VALIDATION_ERROR` | El objeto JSON contiene un campo no compatible, un valor no válido o un argumento obligatorio ausente. |
| 401 | `API_KEY_EXPIRED` | La clave API ha caducado. |
| 401 | `INVALID_API_KEY` | Proporciona una clave de API válida que no haya caducado. |
| 401 | `INVALID_CREDENTIAL` | La cabecera Authorization tiene un formato incorrecto o entra en conflicto con x-api-key. |
| 401 | `MISSING_CREDENTIAL` | No se proporcionó ninguna credencial de cabecera utilizable o superaba 4096 caracteres. |
| 401 | `USER_NOT_FOUND` | La cuenta de la credencial ya no existe. |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | El usuario de la credencial pertenece a más de un equipo, por lo que el contexto de facturación es ambiguo. |
| 403 | `FORBIDDEN` | El glosario no está disponible para el plan del espacio de trabajo. |
| 403 | `INSUFFICIENT_SCOPE` | Concede todos los permisos necesarios o elige otra credencial. |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | No se han podido verificar los límites de integración de la cuenta. |
| 403 | `SUBSCRIPTION_REQUIRED` | Usa una suscripción de pago activa. |
| 403 | `TEAM_MEMBERSHIP_INVALID` | La membresía actual de la cuenta en el equipo no coincide con el espacio de trabajo de esta conexión. Actualiza la membresía y vuelve a conectar. |
| 403 | `TEAM_OWNER_NOT_FOUND` | No se pudo encontrar la cuenta del propietario efectivo del equipo. |
| 404 | `ACCOUNT_NOT_FOUND` | No se pudo encontrar la cuenta o la cuenta del espacio de trabajo activo. |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | Espera al restablecimiento mensual o cambia de plan. |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Espera el tiempo indicado en Retry-After cuando esté presente y aplica esperas progresivas. |
| 500 | `INTERNAL_ERROR` | Comprueba el estado de la solicitud guardada y el historial del recurso antes de decidir si reintentas una modificación. |
| 503 | `SERVER_RESTARTING` | El servidor se está reiniciando. Reinténtalo en breve y conserva el mismo identificador de solicitud para una modificación. |

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