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
}
]
}
}
Glosariusz
Pobierz glosariusz
Pobierz wpisy glosariusza i tryb stosowania dla języka źródłowego. Członkowie zespołu mają dostęp do odczytu glosariusza właściciela.
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
}
]
}
}
Pobierz wpisy glosariusza i tryb stosowania dla języka źródłowego. Członkowie zespołu mają dostęp do odczytu glosariusza właściciela.
Wymagane uprawnienia:
POST https://api.voicecheap.ai/v1/actions/glossary_get
Uwierzytelnianie i uprawnienia
string
wymagane
Wyślij klucz API VoiceCheap w tym nagłówku. Obsługiwany jest również nagłówek Authorization: Bearer z tym samym kluczem API. Tokeny dostępu OAuth są
akceptowane tylko przez MCP, a nie przez ten endpoint REST.
glossary:read.
Wymagana jest aktywna płatna subskrypcja. Uprawnienia nie zmieniają ról w zespole, własności zasobów, kredytów na multimedia ani limitów planu.
Parametry
string
wymagane
Wartość tekstowa.Minimalna długość: 2. Maksymalna długość: 64.
Pełny schemat danych wejściowych
Pełny schemat danych wejściowych
Poniższy JSON Schema zachowuje dokładne nazwy pól, typy zagnieżdżone, wartości domyślne, ograniczenia i akceptowane wartości udostępniane przez mechanizm wykrywania. Dodatkowe reguły zależności między polami znajdują się w uwagach do operacji.
{
"type": "object",
"properties": {
"sourceLanguage": {
"type": "string",
"minLength": 2,
"maxLength": 64
}
},
"required": ["sourceLanguage"],
"additionalProperties": false
}
Przykłady żądań
Zastąp przykładowe identyfikatory zasobów i klucze multimediów wartościami zwróconymi dla Twojego konta. Przy ponawianiu tej samej operacji zmieniającej dane zachowaj identyfikator żądania.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)
Odpowiedź
Pierwsze pomyślne wykonanie zwraca HTTP 200 z wynikiem operacji w data. Ponowienie może zamiast tego zwrócić zapisany stan żądania. Przykład przedstawia jedną obsługiwaną odpowiedź, bez wszystkich opcjonalnych pól. Zwraca ustawienia glosariusza języka źródłowego i publiczne reguły wpisów.{
"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
}
]
}
}
Pola wyniku
| Pole | Opis |
|---|---|
data.glossaryId | Identyfikator glosariusza dla właściciela obszaru roboczego i znormalizowanego języka źródłowego. |
data.sourceLanguage | Znormalizowana nazwa języka źródłowego. |
data.canWrite | Czy wywołujący jest właścicielem tego glosariusza i może go edytować. |
data.isActive | Bieżąca flaga aktywacji glosariusza; dla glosariusza, który jeszcze nie istnieje, domyślnie ma wartość true. |
data.defaultApplicationMode | Domyślny tryb glosariusza: smart lub strict. |
data.entryCount | Zapisana liczba wpisów lub liczba wczytanych wpisów, gdy nie ma zapisanej liczby. |
data.entries | Wpisy glosariusza; pusta tablica, jeśli glosariusz jeszcze nie istnieje. |
data.entries[].entryId | Identyfikator zapisanego wpisu. Może się zmienić wraz ze zmianą terminu źródłowego. |
data.entries[].sourceText | Termin źródłowy zwrócony przez glosariusz, bez skrajnych białych znaków i zapisany małymi literami. |
data.entries[].targets | Mapa przypisująca reguły tłumaczenia do znormalizowanych nazw języków docelowych. |
data.entries[].targets.<language>.text | Tekst do użycia dla tego języka docelowego. |
data.entries[].targets.<language>.mode | translate lub keep. |
data.entries[].targets.<language>.applicationMode | smart lub strict, gdy zapisane w regule docelowej. |
data.entries[].createdAt | Znacznik czasu utworzenia wpisu w milisekundach, zwrócony przez operację zapisu. |
data.entries[].updatedAt | Znacznik czasu zapisania wpisu w milisekundach. |
Uwagi do operacji
- Dla nieznanego glosariusza w obsługiwanym języku źródłowym zwracany jest obliczony glossaryId bez wpisów.
- Tylko właściciel może edytować glosariusz. Członkowie zespołu mają dostęp do odczytu.
Wykorzystanie
Każde pomyślne wywołanie zużywa jedno wywołanie z miesięcznego limitu API/MCP. Obowiązują również kredyty na multimedia oraz limity generowania danej operacji.Błędy
| Status HTTP | Kod | Znaczenie lub sposób rozwiązania |
|---|---|---|
| 400 | BAD_REQUEST | Język źródłowy nie jest obsługiwany. |
| 400 | CREDENTIAL_IN_QUERY | Dane uwierzytelniające zostały podane w parametrze zapytania access_token lub api_key. Wysyłaj dane uwierzytelniające w nagłówkach. |
| 400 | VALIDATION_ERROR | Obiekt JSON zawiera nieobsługiwane pole, nieprawidłową wartość lub brakuje w nim wymaganego argumentu. |
| 401 | API_KEY_EXPIRED | Klucz API wygasł. |
| 401 | INVALID_API_KEY | Podaj prawidłowy, niewygasły klucz API. |
| 401 | INVALID_CREDENTIAL | Nagłówek Authorization ma nieprawidłowy format lub jest sprzeczny z x-api-key. |
| 401 | MISSING_CREDENTIAL | Nie podano użytecznych danych uwierzytelniających w nagłówku lub przekroczyły one 4096 znaków. |
| 401 | USER_NOT_FOUND | Konto powiązane z poświadczeniem już nie istnieje. |
| 403 | AMBIGUOUS_TEAM_API_KEY | Użytkownik, do którego należą dane uwierzytelniające, należy do więcej niż jednego zespołu, więc kontekst rozliczeniowy jest niejednoznaczny. |
| 403 | FORBIDDEN | Glosariusz jest niedostępny w planie obszaru roboczego. |
| 403 | INSUFFICIENT_SCOPE | Nadaj wszystkie wymagane uprawnienia lub wybierz inne dane uwierzytelniające. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Nie udało się zweryfikować limitów integracji konta. |
| 403 | SUBSCRIPTION_REQUIRED | Użyj aktywnej płatnej subskrypcji. |
| 403 | TEAM_MEMBERSHIP_INVALID | Bieżące członkostwo konta w zespole nie odpowiada obszarowi roboczemu tego połączenia. Odśwież członkostwo i połącz się ponownie. |
| 403 | TEAM_OWNER_NOT_FOUND | Nie znaleziono konta faktycznego właściciela zespołu. |
| 404 | ACCOUNT_NOT_FOUND | Nie znaleziono konta lub konta aktywnego obszaru roboczego. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Poczekaj na odnowienie miesięcznego limitu lub zmień plan. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Jeśli występuje nagłówek Retry-After, odczekaj wskazany czas i stosuj rosnące odstępy między ponowieniami. |
| 500 | INTERNAL_ERROR | Sprawdź stan zapisanego żądania i historię zasobu przed podjęciem decyzji o ponowieniu operacji zmieniającej dane. |
| 503 | SERVER_RESTARTING | Serwer jest uruchamiany ponownie. Spróbuj ponownie wkrótce i zachowaj ten sam identyfikator żądania dla operacji zmieniającej dane. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["glossary:read"]
}
}
Czy ta strona była pomocna?

