curl --request POST 'https://api.voicecheap.ai/v1/actions/glossary_import' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","sourceLanguage":"english","importMode":"merge","rows":[{"rowNumber":1,"sourceText":"Product","targets":{"french":{"text":"Produit","mode":"translate","applicationMode":"smart"}}}]}'
const input = {
requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
sourceLanguage: 'english',
importMode: 'merge',
rows: [
{
rowNumber: 1,
sourceText: 'Product',
targets: {
french: {
text: 'Produit',
mode: 'translate',
applicationMode: 'smart',
},
},
},
],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/glossary_import', {
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_import",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "sourceLanguage": "english", "importMode": "merge", "rows": [{"rowNumber": 1, "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)
{
"data": {
"glossaryId": "user_123__english",
"sourceLanguage": "english",
"importedCount": 1,
"entryCount": 1,
"invalidRows": [],
"importMode": "merge"
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "glossary_import",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "glossary_import",
"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"
}
Glossario
Importa le voci del glossario
Importa righe del glossario senza cancellare le voci esistenti. Merge aggiorna i termini corrispondenti; ignore li conserva.
POST
/
v1
/
actions
/
glossary_import
curl --request POST 'https://api.voicecheap.ai/v1/actions/glossary_import' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","sourceLanguage":"english","importMode":"merge","rows":[{"rowNumber":1,"sourceText":"Product","targets":{"french":{"text":"Produit","mode":"translate","applicationMode":"smart"}}}]}'
const input = {
requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
sourceLanguage: 'english',
importMode: 'merge',
rows: [
{
rowNumber: 1,
sourceText: 'Product',
targets: {
french: {
text: 'Produit',
mode: 'translate',
applicationMode: 'smart',
},
},
},
],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/glossary_import', {
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_import",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "sourceLanguage": "english", "importMode": "merge", "rows": [{"rowNumber": 1, "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)
{
"data": {
"glossaryId": "user_123__english",
"sourceLanguage": "english",
"importedCount": 1,
"entryCount": 1,
"invalidRows": [],
"importMode": "merge"
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "glossary_import",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "glossary_import",
"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"
}
Importa righe del glossario senza cancellare le voci esistenti. Merge aggiorna i termini corrispondenti; ignore li conserva.
Autorizzazioni richieste:
POST https://api.voicecheap.ai/v1/actions/glossary_import
Autenticazione e autorizzazioni
string
obbligatorio
Invia una chiave API VoiceCheap in questa intestazione. È supportato anche Authorization: Bearer con la stessa chiave API. I token di accesso OAuth
sono accettati solo da MCP, non da questo endpoint REST.
glossary:write.
È necessario un abbonamento a pagamento attivo. Le autorizzazioni non modificano i ruoli del team, la proprietà delle risorse, i crediti multimediali o i limiti del piano.
Parametri
string
Facoltativo al livello di trasporto: se omesso, il server inserisce un identificatore prima della validazione. Fornisci un tuo UUID v4 stabile per recuperare in sicurezza una risposta persa.Formato: “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}$.string
obbligatorio
Valore testuale.Lunghezza minima: 2. Lunghezza massima: 64.
string
Valore testuale.Valori consentiti: “merge”, “replace”, “ignore”. Valore predefinito: “merge”.
array
obbligatorio
Elenco di valori. Consulta lo schema di input completo per la struttura degli elementi.Numero minimo di elementi: 1. Numero massimo di elementi: 500.
Schema di input completo
Schema di input completo
Il JSON Schema seguente conserva i nomi esatti dei campi, i tipi annidati, i valori predefiniti, i limiti e i valori accettati esposti dalla discovery. Le ulteriori regole tra campi sono elencate nelle note sull’operazione.
{
"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
},
"importMode": {
"default": "merge",
"type": "string",
"enum": ["merge", "replace", "ignore"]
},
"rows": {
"minItems": 1,
"maxItems": 500,
"type": "array",
"items": {
"type": "object",
"properties": {
"rowNumber": {
"type": "integer",
"minimum": 1,
"maximum": 9007199254740991
},
"sourceText": {
"type": "string",
"minLength": 1,
"maxLength": 500
},
"targets": {
"type": "object",
"propertyNames": {
"type": "string",
"minLength": 2,
"maxLength": 64
},
"additionalProperties": {
"type": "object",
"properties": {
"text": {
"type": "string",
"maxLength": 2000
},
"mode": {
"type": "string",
"enum": ["translate", "keep"]
},
"applicationMode": {
"type": "string",
"enum": ["smart", "strict"]
}
},
"required": ["text", "mode"],
"additionalProperties": false
}
}
},
"required": ["rowNumber", "sourceText", "targets"],
"additionalProperties": false
}
}
},
"required": ["sourceLanguage", "rows"],
"additionalProperties": false
}
Idempotenza
Usa un UUID v4 in requestId o nell’intestazione HTTP Idempotency-Key per ogni modifica. Riutilizza lo stesso identificatore e argomenti identici dopo un errore di rete. Se vengono forniti entrambi, devono coincidere. Ripetere una richiesta salvata non ripete l’operazione e non consuma un’altra chiamata mensile. Le richieste non riuscite o interrotte non vengono riavviate automaticamente. Ogni modifica può restituire HTTP 202 quando un nuovo tentativo trova la stessa richiesta ancora in esecuzione, anche se la prima esecuzione è normalmente sincrona. Se l’esecuzione è completata ma resultStored è false, un nuovo tentativo restituisce HTTP 200 con lo stato della richiesta salvata anziché il risultato originale. Recupera l’output tramite l’azione di cronologia, risultato o download del relativo dominio.Esempi di richiesta
Sostituisci gli identificatori delle risorse e le chiavi multimediali di esempio con i valori restituiti per il tuo account. Mantieni stabile l’identificatore della richiesta quando ripeti la stessa modifica.curl --request POST 'https://api.voicecheap.ai/v1/actions/glossary_import' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"requestId":"58d5bb53-00d0-4692-bdaf-c6650ee87e30","sourceLanguage":"english","importMode":"merge","rows":[{"rowNumber":1,"sourceText":"Product","targets":{"french":{"text":"Produit","mode":"translate","applicationMode":"smart"}}}]}'
const input = {
requestId: '58d5bb53-00d0-4692-bdaf-c6650ee87e30',
sourceLanguage: 'english',
importMode: 'merge',
rows: [
{
rowNumber: 1,
sourceText: 'Product',
targets: {
french: {
text: 'Produit',
mode: 'translate',
applicationMode: 'smart',
},
},
},
],
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/glossary_import', {
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_import",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30", "sourceLanguage": "english", "importMode": "merge", "rows": [{"rowNumber": 1, "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)
Risposta
Una prima esecuzione riuscita restituisce HTTP 200 con il risultato dell’operazione in data. Una ripetizione può invece restituire lo stato della richiesta salvata. L’esempio mostra una risposta supportata, non tutti i campi facoltativi. Restituisce il riepilogo dell’importazione con il numero di righe importate, il numero di voci risultanti e le righe non valide o saltate.{
"data": {
"glossaryId": "user_123__english",
"sourceLanguage": "english",
"importedCount": 1,
"entryCount": 1,
"invalidRows": [],
"importMode": "merge"
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "glossary_import",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30"
}
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "glossary_import",
"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"
}
Campi del risultato
| Campo | Descrizione |
|---|---|
data.glossaryId | Identificatore del glossario importato. |
data.sourceLanguage | Lingua di origine normalizzata. |
data.importedCount | Numero di righe valide passate all’operazione di salvataggio dell’importazione. |
data.entryCount | Numero totale di voci salvate nel glossario dopo l’importazione. |
data.invalidRows | Righe non valide o saltate con rowNumber, sourceText facoltativo e reason. |
data.invalidRows[].rowNumber | Identificatore della riga dal payload inviato. |
data.invalidRows[].sourceText | Termine di origine, quando disponibile. |
data.invalidRows[].reason | Motivo per cui la riga non era valida o è stata ignorata. |
data.importMode | Modalità richiesta, con merge come valore predefinito. |
Recupera e monitora questa richiesta
Usa lo stesso identificatore anche dopo una connessione persa. Se resultStored è false, recupera l’output tramite la corrispondente azione di cronologia, risultato o download. Non avviare mai una seconda generazione solo per verificarne l’avanzamento.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_import"}'
HTTP 200
{
"data": {
"requestId": "58d5bb53-00d0-4692-bdaf-c6650ee87e30",
"operation": "glossary_import",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"glossaryId": "user_123__english",
"sourceLanguage": "english",
"importedCount": 1,
"entryCount": 1,
"invalidRows": [],
"importMode": "merge"
}
}
}
Note sull’operazione
- Accetta 1–500 righe strutturate con 1–200 lingue di destinazione per riga. Ogni oggetto di destinazione richiede text e mode.
- merge è il valore predefinito. ignore salta i termini di origine già presenti e li segnala in invalidRows.
- L’implementazione attuale accetta replace ma salva tramite la stessa operazione merge; non rimuove le voci omesse dal payload. Non fare affidamento su replace per svuotare un glossario esistente.
- I termini di origine duplicati e le lingue di destinazione sconosciute vengono segnalati come righe non valide. La richiesta non riesce se non rimangono righe valide.
- Quando una destinazione di riga omette applicationMode, l’importazione attualmente assegna strict a quella destinazione. Fornisci smart o strict esplicitamente quando la modalità desiderata è rilevante.
Utilizzo
Ogni invocazione riuscita consuma una chiamata API/MCP mensile. Si applicano anche i crediti multimediali e le quote di generazione proprie dell’operazione.Errori
| Stato HTTP | Codice | Significato o risoluzione |
|---|---|---|
| 400 | BAD_REQUEST | Dopo la convalida non rimangono righe valide nel glossario. |
| 400 | CREDENTIAL_IN_QUERY | Le credenziali sono state fornite in un parametro di query access_token o api_key. Invia le credenziali negli header. |
| 400 | GLOSSARY_IMPORT_UNKNOWN_LANGUAGE | La lingua sorgente dell’importazione non è supportata. |
| 400 | IDEMPOTENCY_CONFLICT | L’intestazione Idempotency-Key e il campo requestId del corpo devono coincidere. |
| 400 | INVALID_REQUEST_ID | Fornisci requestId o Idempotency-Key come UUID v4. |
| 400 | VALIDATION_ERROR | L’oggetto JSON contiene un campo non supportato, un valore non valido o un argomento obbligatorio mancante. |
| 401 | API_KEY_EXPIRED | La chiave API è scaduta. |
| 401 | INVALID_API_KEY | Fornisci una chiave API valida e non scaduta. |
| 401 | INVALID_CREDENTIAL | L’header Authorization non è valido oppure è in conflitto con x-api-key. |
| 401 | MISSING_CREDENTIAL | Non è stata fornita alcuna credenziale utilizzabile negli header, oppure la credenziale superava 4096 caratteri. |
| 401 | USER_NOT_FOUND | L’account associato alla credenziale non esiste più. |
| 403 | ACCOUNT_UNAVAILABLE | L’account che esegue l’azione o quello di fatturazione non è disponibile o è in fase di eliminazione. |
| 403 | AMBIGUOUS_TEAM_API_KEY | L’utente della credenziale appartiene a più di un team, quindi il contesto di fatturazione è ambiguo. |
| 403 | FORBIDDEN | Solo il proprietario dell’area di lavoro a pagamento può modificarne il glossario. I membri del team hanno accesso in sola lettura. |
| 403 | INSUFFICIENT_SCOPE | Concedi tutte le autorizzazioni richieste o scegli un’altra credenziale. |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | Impossibile verificare i limiti di integrazione dell’account. |
| 403 | SUBSCRIPTION_REQUIRED | Usa un abbonamento a pagamento attivo. |
| 403 | TEAM_MEMBERSHIP_INVALID | L’appartenenza attuale dell’account al team non corrisponde all’area di lavoro di questa connessione. Aggiorna l’appartenenza e riconnettiti. |
| 403 | TEAM_OWNER_NOT_FOUND | Non è stato possibile trovare l’account effettivo del proprietario del team. |
| 404 | ACCOUNT_NOT_FOUND | Non è stato possibile trovare l’account o l’account dell’area di lavoro attiva. |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | Questo account ha già 10 azioni di integrazione in esecuzione. Interroga una richiesta esistente prima di avviarne un’altra. |
| 409 | IDEMPOTENCY_CONFLICT | Riutilizza un identificatore solo con la stessa operazione e gli stessi argomenti. |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | Attendi il ripristino mensile o cambia piano. |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Rispetta Retry-After quando presente e applica attese crescenti tra i tentativi. |
| 500 | INTERNAL_ERROR | Controlla lo stato della richiesta salvata e la cronologia delle risorse prima di decidere se ripetere una modifica. |
| 503 | ACTION_RESULT_UNAVAILABLE | L’azione è stata eseguita ma non è stato possibile salvarne il risultato. Esamina lo stato della richiesta salvata e la cronologia delle risorse prima di avviare una nuova generazione. |
| 503 | SERVER_RESTARTING | Il server si sta riavviando. Riprova tra poco e mantieni lo stesso identificatore della richiesta per una modifica. |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["glossary:write"]
}
}
Questa pagina è stata utile?

