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
}
]
}
}
Glossar
Glossar abrufen
Rufen Sie die Glossareinträge und den Anwendungsmodus für eine Ausgangssprache ab. Teammitglieder haben Lesezugriff auf das Glossar des Eigentümers.
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
}
]
}
}
Rufen Sie die Glossareinträge und den Anwendungsmodus für eine Ausgangssprache ab. Teammitglieder haben Lesezugriff auf das Glossar des Eigentümers.
Erforderliche Berechtigungen:
POST https://api.voicecheap.ai/v1/actions/glossary_get
Authentifizierung und Berechtigungen
string
erforderlich
Senden Sie einen VoiceCheap-API-Schlüssel in diesem Header. Authorization: Bearer mit demselben API-Schlüssel wird ebenfalls unterstützt.
OAuth-Zugriffstoken werden nur von MCP akzeptiert, nicht von diesem REST-Endpunkt.
glossary:read.
Ein aktives kostenpflichtiges Abonnement ist erforderlich. Berechtigungen ändern weder Teamrollen noch Ressourceneigentum, Medienguthaben oder Tariflimits.
Parameter
string
erforderlich
Textwert.Mindestlänge: 2. Höchstlänge: 64.
Vollständiges Eingabeschema
Vollständiges Eingabeschema
Das folgende JSON Schema enthält die exakten Feldnamen, verschachtelten Typen, Standardwerte, Grenzen und akzeptierten Werte aus der Discovery. Zusätzliche feldübergreifende Regeln finden Sie in den Hinweisen zur Operation.
{
"type": "object",
"properties": {
"sourceLanguage": {
"type": "string",
"minLength": 2,
"maxLength": 64
}
},
"required": ["sourceLanguage"],
"additionalProperties": false
}
Anfragebeispiele
Ersetzen Sie die beispielhaften Ressourcenkennungen und Medienschlüssel durch Werte, die für Ihr Konto zurückgegeben wurden. Behalten Sie bei Wiederholungen derselben Mutation dieselbe Anfragekennung bei.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)
Antwort
Eine erfolgreiche erste Ausführung gibt HTTP 200 mit dem Ergebnis der Operation unter data zurück. Bei einer Wiederholung kann stattdessen der gespeicherte Anfragestatus zurückgegeben werden. Das Beispiel zeigt eine unterstützte Antwort, nicht alle optionalen Felder. Gibt die Glossareinstellungen und öffentlichen Eintragsregeln der Quellsprache zurück.{
"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
}
]
}
}
Ergebnisfelder
| Feld | Beschreibung |
|---|---|
data.glossaryId | Glossarkennung für den Eigentümer des Arbeitsbereichs und die normalisierte Ausgangssprache. |
data.sourceLanguage | Normalisierter Name der Quellsprache. |
data.canWrite | Ob der Aufrufer Inhaber dieses Glossars ist und es bearbeiten darf. |
data.isActive | Aktuelles Aktivierungsflag des Glossars; bei einem noch nicht vorhandenen Glossar standardmäßig true. |
data.defaultApplicationMode | Standardmodus smart oder strict für das Glossar. |
data.entryCount | Gespeicherte Eintragsanzahl oder die Anzahl geladener Einträge, wenn keine gespeicherte Anzahl vorhanden ist. |
data.entries | Glossareinträge; ein leeres Array, wenn das Glossar noch nicht vorhanden ist. |
data.entries[].entryId | Kennung des gespeicherten Eintrags. Sie kann sich ändern, wenn sich der Quellbegriff ändert. |
data.entries[].sourceText | Vom Glossar zurückgegebener Ausgangsbegriff in Kleinbuchstaben und ohne führende oder nachgestellte Leerzeichen. |
data.entries[].targets | Zuordnung normalisierter Zielsprachennamen zu Übersetzungsregeln. |
data.entries[].targets.<language>.text | Text, der für diese Zielsprache verwendet werden soll. |
data.entries[].targets.<language>.mode | translate oder keep. |
data.entries[].targets.<language>.applicationMode | smart oder strict, wenn in der Zielregel gespeichert. |
data.entries[].createdAt | Erstellungszeitstempel des Eintrags in Millisekunden, wie vom Speichervorgang zurückgegeben. |
data.entries[].updatedAt | Zeitstempel der Eintragsspeicherung in Millisekunden. |
Hinweise zur Operation
- Bei einem unbekannten Glossar für eine unterstützte Ausgangssprache wird die berechnete glossaryId ohne Einträge zurückgegeben.
- Nur der Eigentümer kann das Glossar bearbeiten. Teammitglieder haben Lesezugriff.
Nutzung
Jeder erfolgreiche Aufruf verbraucht einen monatlichen API/MCP-Aufruf. Zusätzlich gelten das Medienguthaben und die eigenen Generierungskontingente der Operation.Fehler
| HTTP-Status | Code | Bedeutung oder Behebung |
|---|---|---|
| 400 | BAD_REQUEST | Die Quellsprache wird nicht unterstützt. |
| 400 | CREDENTIAL_IN_QUERY | Zugangsdaten wurden in einem Abfrageparameter namens access_token oder api_key übergeben. Senden Sie Zugangsdaten in Headern. |
| 400 | VALIDATION_ERROR | Das JSON-Objekt enthält ein nicht unterstütztes Feld, einen ungültigen Wert oder ein fehlendes erforderliches Argument. |
| 401 | API_KEY_EXPIRED | Der API-Schlüssel ist abgelaufen. |
| 401 | INVALID_API_KEY | Geben Sie einen gültigen, nicht abgelaufenen API-Schlüssel an. |
| 401 | INVALID_CREDENTIAL | Der Authorization-Header ist fehlerhaft oder steht im Konflikt mit x-api-key. |
| 401 | MISSING_CREDENTIAL | Es wurde kein nutzbarer Berechtigungsnachweis im Header übergeben, oder er überschritt 4096 Zeichen. |
| 401 | USER_NOT_FOUND | Das Konto des Zugangsnachweises existiert nicht mehr. |
| 403 | AMBIGUOUS_TEAM_API_KEY | Der Benutzer des Berechtigungsnachweises gehört mehr als einem Team an, weshalb der Abrechnungskontext nicht eindeutig ist. |
| 403 | FORBIDDEN | Das Glossar ist im Tarif des Arbeitsbereichs nicht verfügbar. |
| 403 | INSUFFICIENT_SCOPE | Erteilen Sie alle erforderlichen Berechtigungen oder verwenden Sie andere Zugangsdaten. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Die Integrationslimits des Kontos konnten nicht verifiziert werden. |
| 403 | SUBSCRIPTION_REQUIRED | Verwenden Sie ein aktives kostenpflichtiges Abonnement. |
| 403 | TEAM_MEMBERSHIP_INVALID | Die aktuelle Teammitgliedschaft des Kontos stimmt nicht mit dem Arbeitsbereich dieser Verbindung überein. Aktualisieren Sie die Mitgliedschaft und stellen Sie die Verbindung erneut her. |
| 403 | TEAM_OWNER_NOT_FOUND | Das maßgebliche Konto des Teaminhabers wurde nicht gefunden. |
| 404 | ACCOUNT_NOT_FOUND | Das Konto oder das Konto des aktiven Arbeitsbereichs wurde nicht gefunden. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Warten Sie auf die monatliche Zurücksetzung oder wechseln Sie den Tarif. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Warten Sie gegebenenfalls die in Retry-After angegebene Zeit und verwenden Sie zunehmend längere Warteintervalle. |
| 500 | INTERNAL_ERROR | Prüfen Sie den Status der gespeicherten Anfrage und den Ressourcenverlauf, bevor Sie eine Mutation erneut versuchen. |
| 503 | SERVER_RESTARTING | Der Server wird neu gestartet. Versuchen Sie es in Kürze erneut und behalten Sie bei einer Mutation dieselbe Anfragekennung bei. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["glossary:read"]
}
}
War diese Seite hilfreich?

