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"}'
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);
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)
{
"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
}
]
}
}
Glossaire
Consulter un glossaire
Consultez les entrées du glossaire et le mode d’application pour une langue source. Les membres de l’équipe peuvent lire le glossaire du propriétaire.
POST
/
v1
/
actions
/
glossary_get
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"}'
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);
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)
{
"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
}
]
}
}
Consultez les entrées du glossaire et le mode d’application pour une langue source. Les membres de l’équipe peuvent lire le glossaire du propriétaire.
Autorisations requises:
POST https://api.voicecheap.ai/v1/actions/glossary_get
Authentification et autorisations
string
requis
Envoyez une clé API VoiceCheap dans cet en-tête. Authorization: Bearer avec la même clé API est également accepté. Les jetons d’accès OAuth sont
acceptés uniquement par MCP, pas par cet endpoint REST.
glossary:read.
Un abonnement payant actif est requis. Les autorisations ne modifient ni les rôles dans l’équipe, ni la propriété des ressources, ni les crédits média, ni les limites du forfait.
Paramètres
string
requis
Valeur textuelle.Longueur minimale: 2. Longueur maximale: 64.
Schéma d’entrée complet
Schéma d’entrée complet
Le JSON Schema ci-dessous conserve les noms de champs exacts, les types imbriqués, les valeurs par défaut, les limites et les valeurs acceptées exposés par la découverte. Les règles supplémentaires entre champs figurent dans les notes de l’opération.
{
"type": "object",
"properties": {
"sourceLanguage": {
"type": "string",
"minLength": 2,
"maxLength": 64
}
},
"required": ["sourceLanguage"],
"additionalProperties": false
}
Exemples de requêtes
Remplacez les exemples d’identifiants de ressources et de clés média par des valeurs renvoyées pour votre compte. Conservez le même identifiant de requête lorsque vous réessayez la même mutation.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"}'
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);
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)
Réponse
Une première exécution réussie renvoie HTTP 200 avec le résultat de l’opération sous data. Une nouvelle tentative peut renvoyer à la place l’état de la requête enregistrée. L’exemple présente une réponse possible, sans tous les champs facultatifs. Renvoie les paramètres du glossaire de la langue source et les règles publiques de ses entrées.{
"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
}
]
}
}
Champs du résultat
| Champ | Description |
|---|---|
data.glossaryId | Identifiant du glossaire pour le propriétaire de l’espace de travail et la langue source normalisée. |
data.sourceLanguage | Nom normalisé de la langue source. |
data.canWrite | Indique si l’appelant est propriétaire de ce glossaire et peut le modifier. |
data.isActive | Indicateur d’activation actuel du glossaire ; vaut true par défaut pour un glossaire qui n’existe pas encore. |
data.defaultApplicationMode | Mode par défaut du glossaire : smart ou strict. |
data.entryCount | Nombre d’entrées enregistré, ou nombre d’entrées chargées si aucun nombre n’est enregistré. |
data.entries | Entrées du glossaire ; un tableau vide si le glossaire n’existe pas encore. |
data.entries[].entryId | Identifiant de l’entrée enregistrée. Il peut changer lorsque le terme source change. |
data.entries[].sourceText | Terme source renvoyé par le glossaire, sans espaces en début ou en fin et en minuscules. |
data.entries[].targets | Table de correspondance entre les noms normalisés des langues cibles et les règles de traduction. |
data.entries[].targets.<language>.text | Texte à utiliser pour cette langue cible. |
data.entries[].targets.<language>.mode | translate ou keep. |
data.entries[].targets.<language>.applicationMode | smart ou strict lorsque la valeur est enregistrée dans la règle cible. |
data.entries[].createdAt | Horodatage de création de l’entrée en millisecondes, tel que renvoyé par l’opération d’enregistrement. |
data.entries[].updatedAt | Horodatage d’enregistrement de l’entrée en millisecondes. |
Notes de l’opération
- Un glossaire inconnu pour une langue source prise en charge renvoie son glossaryId calculé, sans entrées.
- Seul le propriétaire peut modifier le glossaire. Les membres de l’équipe disposent d’un accès en lecture.
Utilisation
Chaque invocation réussie consomme un appel du quota mensuel API/MCP. Les crédits média et les quotas de génération propres à l’opération s’appliquent également.Erreurs
| Statut HTTP | Code | Signification ou solution |
|---|---|---|
| 400 | BAD_REQUEST | La langue source n’est pas prise en charge. |
| 400 | CREDENTIAL_IN_QUERY | Des identifiants ont été fournis dans un paramètre de requête access_token ou api_key. Envoyez les identifiants dans les en-têtes. |
| 400 | VALIDATION_ERROR | L’objet JSON contient un champ non pris en charge, une valeur invalide ou un argument obligatoire manquant. |
| 401 | API_KEY_EXPIRED | La clé API a expiré. |
| 401 | INVALID_API_KEY | Fournissez une clé API valide et non expirée. |
| 401 | INVALID_CREDENTIAL | L’en-tête Authorization est mal formé ou entre en conflit avec x-api-key. |
| 401 | MISSING_CREDENTIAL | Aucun identifiant d’authentification utilisable n’a été fourni dans les en-têtes, ou il dépassait 4096 caractères. |
| 401 | USER_NOT_FOUND | Le compte associé à l’identifiant d’accès n’existe plus. |
| 403 | AMBIGUOUS_TEAM_API_KEY | L’utilisateur associé aux identifiants d’authentification appartient à plusieurs équipes, ce qui rend le contexte de facturation ambigu. |
| 403 | FORBIDDEN | Le glossaire est indisponible avec le forfait de l’espace de travail. |
| 403 | INSUFFICIENT_SCOPE | Accordez toutes les autorisations requises ou choisissez d’autres identifiants d’accès. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Les limites d’intégration du compte n’ont pas pu être vérifiées. |
| 403 | SUBSCRIPTION_REQUIRED | Utilisez un abonnement payant actif. |
| 403 | TEAM_MEMBERSHIP_INVALID | L’appartenance actuelle du compte à une équipe ne correspond pas à l’espace de travail de cette connexion. Actualisez l’appartenance et reconnectez-vous. |
| 403 | TEAM_OWNER_NOT_FOUND | Le compte du propriétaire effectif de l’équipe est introuvable. |
| 404 | ACCOUNT_NOT_FOUND | Le compte ou le compte de l’espace de travail actif est introuvable. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Attendez la réinitialisation mensuelle ou changez de forfait. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Respectez Retry-After lorsqu’il est présent et espacez progressivement les nouvelles tentatives. |
| 500 | INTERNAL_ERROR | Vérifiez l’état de la requête enregistrée et l’historique de la ressource avant de décider de réessayer une mutation. |
| 503 | SERVER_RESTARTING | Le serveur redémarre. Réessayez dans un instant en conservant le même identifiant de requête pour une mutation. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["glossary:read"]
}
}
Cette page vous a-t-elle été utile ?

