> ## 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. # Utwórz lub zaktualizuj wpis glosariusza > Utwórz lub zastąp termin źródłowy i jego tłumaczenia. Tylko właściciel glosariusza może modyfikować wpisy. Utwórz lub zastąp termin źródłowy i jego tłumaczenia. Tylko właściciel glosariusza może modyfikować wpisy. ```http theme={null} POST https://api.voicecheap.ai/v1/actions/glossary_entry_upsert ``` ## Uwierzytelnianie i uprawnienia 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. Wymagane uprawnienia: `glossary:write`. 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 Opcjonalne na poziomie transportu: jeśli identyfikator zostanie pominięty, serwer doda go przed walidacją. Podaj własny, stały UUID v4, aby bezpiecznie odzyskać wynik po utracie odpowiedzi. Format: "uuid". Wzorzec: `^[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}$`. Wartość tekstowa. Minimalna długość: 2. Maksymalna długość: 64. Wartość tekstowa. Minimalna długość: 1. Maksymalna długość: 500. Obiekt JSON. Pola zagnieżdżone opisuje 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. ```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 } ``` ## Idempotencja Dla każdej operacji zmieniającej dane użyj UUID v4 w requestId lub w nagłówku HTTP Idempotency-Key. Po awarii sieci użyj ponownie tego samego identyfikatora i identycznych argumentów. Jeśli podasz oba, muszą być zgodne. Ponowienie zapisanego żądania nie powtarza operacji ani nie zużywa kolejnego wywołania z miesięcznego limitu. Żądania zakończone błędem lub przerwane nie są automatycznie uruchamiane ponownie. Każda operacja zmieniająca dane może zwrócić HTTP 202, gdy ponowienie napotka to samo żądanie nadal w stanie running, nawet jeśli jej pierwsze wykonanie zwykle jest synchroniczne. Jeśli wykonanie się zakończyło, ale resultStored ma wartość false, ponowienie zwraca HTTP 200 z zapisanym stanem żądania zamiast pierwotnego wyniku. Pobierz wynik za pomocą akcji historii, wyniku lub pobierania właściwej dla danej domeny. ## 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. ```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) ``` ## 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 zapisany wpis wraz ze znormalizowanym terminem źródłowym i regułami docelowymi. ```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" } ``` ## 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.entry.entryId` | Identyfikator zapisanego wpisu. Może się zmienić wraz ze zmianą terminu źródłowego. | | `data.entry.sourceText` | Termin źródłowy zwrócony przez glosariusz, bez skrajnych białych znaków i zapisany małymi literami. | | `data.entry.targets` | Mapa przypisująca reguły tłumaczenia do znormalizowanych nazw języków docelowych. | | `data.entry.targets..text` | Tekst do użycia dla tego języka docelowego. | | `data.entry.targets..mode` | translate lub keep. | | `data.entry.targets..applicationMode` | smart lub strict, gdy zapisane w regule docelowej. | | `data.entry.createdAt` | Znacznik czasu utworzenia wpisu w milisekundach, zwrócony przez operację zapisu. | | `data.entry.updatedAt` | Znacznik czasu zapisania wpisu w milisekundach. | ## Odzyskaj żądanie i sprawdź jego stan Używaj tego samego identyfikatora także po utracie połączenia. Jeśli resultStored ma wartość false, pobierz wynik za pomocą odpowiedniej akcji historii, wyniku lub pobierania. Nigdy nie uruchamiaj drugiego generowania tylko po to, aby sprawdzić postęp. ```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 } } } } ``` ## Uwagi do operacji * Przyjmuje 1–200 języków docelowych. Wartość docelowa może być ciągiem znaków lub obiektem zawierającym text, opcjonalne mode i opcjonalne applicationMode. * Terminy źródłowe zawierają 1–500 znaków; tekst docelowy zawiera maksymalnie 2,000 znaków. * Z terminu źródłowego usuwane są skrajne białe znaki, a litery są zamieniane na małe na potrzeby przechowywania i identyfikacji wpisu. Użyj zwróconego entryId przy późniejszych aktualizacjach lub usuwaniu. * Puste wartości docelowe są ignorowane. Musi pozostać co najmniej jedna niepusta wartość docelowa. Tekst docelowy identyczny z terminem źródłowym jest zapisywany w trybie keep. ## 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 lub docelowy jest nieobsługiwany albo po normalizacji nie pozostało żadne niepuste tłumaczenie docelowe. | | 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 | `IDEMPOTENCY_CONFLICT` | Nagłówek Idempotency-Key i pole requestId w treści żądania muszą być zgodne. | | 400 | `INVALID_REQUEST_ID` | Podaj requestId lub Idempotency-Key w formacie UUID v4. | | 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 | `ACCOUNT_UNAVAILABLE` | Konto wykonujące operację lub konto rozliczeniowe jest niedostępne albo jest w trakcie usuwania. | | 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` | Tylko właściciel płatnego obszaru roboczego może edytować jego glosariusz. Członkowie zespołu mają jedynie dostęp do odczytu. | | 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. | | 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | Na tym koncie działa już 10 akcji integracji. Sprawdzaj stan istniejącego żądania przed rozpoczęciem kolejnego. | | 409 | `IDEMPOTENCY_CONFLICT` | Używaj ponownie identyfikatora wyłącznie z tą samą operacją i tymi samymi argumentami. | | 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 | `ACTION_RESULT_UNAVAILABLE` | Akcja została wykonana, ale nie udało się zapisać jej wyniku. Sprawdź zapisany stan żądania i historię zasobu przed rozpoczęciem nowego generowania. | | 503 | `SERVER_RESTARTING` | Serwer jest uruchamiany ponownie. Spróbuj ponownie wkrótce i zachowaj ten sam identyfikator żądania dla operacji zmieniającej dane. | ```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.