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

# Crear o actualizar una entrada del glosario

> Crea o sustituye un término de origen y sus traducciones. Solo el propietario del glosario puede modificar las entradas.

Crea o sustituye un término de origen y sus traducciones. Solo el propietario del glosario puede modificar las entradas.

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

## 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:write`.

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="requestId" type="string">
  Opcional en la capa de transporte: el servidor introduce un identificador antes de la validación si se omite. Proporciona tu propio UUID v4 estable para recuperar la solicitud de forma segura si se pierde la respuesta.

  Formato: "uuid". Patrón: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`.
</ParamField>

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

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

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

  Longitud mínima: 1. Longitud máxima: 500.
</ParamField>

<ParamField body="targets" type="object" required>
  Objeto JSON. Consulta sus campos anidados en el esquema completo de entrada.
</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": {
      "requestId": {
        "type": "string",
        "format": "uuid",
        "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$",
        "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
      },
      "sourceLanguage": {
        "type": "string",
        "minLength": 2,
        "maxLength": 64
      },
      "sourceText": {
        "type": "string",
        "minLength": 1,
        "maxLength": 500
      },
      "targets": {
        "type": "object",
        "propertyNames": {
          "type": "string",
          "minLength": 2,
          "maxLength": 64
        },
        "additionalProperties": {
          "anyOf": [
            {
              "type": "string",
              "maxLength": 2000
            },
            {
              "type": "object",
              "properties": {
                "text": {
                  "type": "string",
                  "maxLength": 2000
                },
                "mode": {
                  "type": "string",
                  "enum": ["translate", "keep"]
                },
                "applicationMode": {
                  "type": "string",
                  "enum": ["smart", "strict"]
                }
              },
              "required": ["text"],
              "additionalProperties": false
            }
          ]
        }
      }
    },
    "required": ["sourceLanguage", "sourceText", "targets"],
    "additionalProperties": false
  }
  ```
</Accordion>

## Idempotencia

Usa un UUID v4 en requestId o en la cabecera HTTP Idempotency-Key para cada modificación. Reutiliza el mismo identificador y argumentos idénticos después de un fallo de red. Si proporcionas ambos, deben coincidir. Repetir una solicitud guardada no vuelve a ejecutar la operación ni consume otra llamada mensual. Las solicitudes fallidas o interrumpidas no se reinician automáticamente.

Toda modificación puede devolver HTTP 202 cuando un reintento encuentra la misma solicitud todavía en ejecución, incluso si su primera ejecución suele ser síncrona. Si la ejecución ha terminado pero resultStored es false, un reintento devuelve HTTP 200 con el estado de la solicitud guardada en lugar del resultado original. Recupera la salida mediante la acción de historial, resultado o descarga de su ámbito.

## 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_entry_upsert' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","sourceLanguage":"english","sourceText":"Product","targets":{"french":{"text":"Produit","mode":"translate","applicationMode":"smart"}}}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
    sourceLanguage: 'english',
    sourceText: 'Product',
    targets: {
      french: {
        text: 'Produit',
        mode: 'translate',
        applicationMode: 'smart',
      },
    },
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/glossary_entry_upsert', {
    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_entry_upsert",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "sourceLanguage": "english", "sourceText": "Product", "targets": {"french": {"text": "Produit", "mode": "translate", "applicationMode": "smart"}}},
      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 la entrada guardada con su término de origen normalizado y sus reglas de destino.

<ResponseExample>
  ```json HTTP 200 theme={null}
  {
    "data": {
      "glossaryId": "user_123__english",
      "sourceLanguage": "english",
      "entry": {
        "entryId": "a8792157cb4f27fb949c035f45518c61e884bb86",
        "sourceText": "product",
        "targets": {
          "french": {
            "text": "Produit",
            "mode": "translate",
            "applicationMode": "smart"
          }
        },
        "createdAt": 1792152000000,
        "updatedAt": 1792152000000
      }
    },
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
      "operation": "glossary_entry_upsert",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
      "operation": "glossary_entry_upsert",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
  }
  ```
</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.entry.entryId` | Identificador de la entrada guardada. Puede cambiar cuando cambia el término de origen. |
| `data.entry.sourceText` | Término de origen devuelto por el glosario, en minúsculas y sin espacios en los extremos. |
| `data.entry.targets` | Mapa de nombres normalizados de idiomas de destino a reglas de traducción. |
| `data.entry.targets.<language>.text` | Texto que se usará para ese idioma de destino. |
| `data.entry.targets.<language>.mode` | translate o keep. |
| `data.entry.targets.<language>.applicationMode` | smart o strict cuando se almacena en la regla de destino. |
| `data.entry.createdAt` | Marca de tiempo de creación de la entrada en milisegundos, tal como la devuelve la operación de guardado. |
| `data.entry.updatedAt` | Marca de tiempo de guardado de la entrada en milisegundos. |

## Recuperar y consultar esta solicitud

Usa el mismo identificador incluso después de perder la conexión. Si resultStored es false, recupera la salida mediante la acción correspondiente de historial, resultado o descarga. Nunca inicies una segunda generación solo para comprobar el progreso.

```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","operation":"glossary_entry_upsert"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
    "operation": "glossary_entry_upsert",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "glossaryId": "user_123__english",
      "sourceLanguage": "english",
      "entry": {
        "entryId": "a8792157cb4f27fb949c035f45518c61e884bb86",
        "sourceText": "product",
        "targets": {
          "french": {
            "text": "Produit",
            "mode": "translate",
            "applicationMode": "smart"
          }
        },
        "createdAt": 1792152000000,
        "updatedAt": 1792152000000
      }
    }
  }
}
```

## Notas de la operación

* Acepta 1–200 idiomas de destino. Un destino puede ser una cadena o un objeto que contenga text, mode opcional y applicationMode opcional.
* Los términos de origen contienen 1–500 caracteres; el texto de destino contiene como máximo 2,000 caracteres.
* Al término de origen se le eliminan los espacios al principio y al final y se convierte a minúsculas para guardarlo e identificar la entrada. Usa el entryId devuelto para actualizaciones o eliminaciones posteriores.
* Los destinos en blanco se ignoran. Debe quedar al menos un destino con contenido. El texto de destino igual al término de origen se guarda en modo keep.

## 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` | Un idioma de origen o destino no es compatible, o no queda ninguna traducción de destino no vacía tras la normalización. |
| 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 | `IDEMPOTENCY_CONFLICT` | La cabecera Idempotency-Key y el campo requestId del cuerpo deben coincidir. |
| 400 | `INVALID_REQUEST_ID` | Proporciona un UUID v4 en requestId o Idempotency-Key. |
| 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 | `ACCOUNT_UNAVAILABLE` | La cuenta que realiza la acción o la cuenta de facturación no está disponible o se está eliminando. |
| 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` | Solo el propietario del espacio de trabajo de pago puede editar su glosario. Los miembros del equipo solo tienen acceso de lectura. |
| 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. |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Esta cuenta ya tiene 10 acciones de integración en ejecución. Consulta una solicitud existente antes de iniciar otra. |
| 409 | `IDEMPOTENCY_CONFLICT` | Reutiliza un identificador solo con la misma operación y los mismos argumentos. |
| 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 | `ACTION_RESULT_UNAVAILABLE` | La acción se ejecutó, pero no se pudo guardar su resultado. Revisa el estado de la solicitud guardada y el historial del recurso antes de iniciar una nueva generació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:write"]
  }
}
```


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