Documentazione

REFERENZA API

Semplifica e traduci i contenuti in 24 lingue di output.

L'endpoint sincrono accetta testo di origine, impostazioni internazionali di output e una delle due modalità. Rileva automaticamente la lingua di origine e restituisce un risultato pronto per l'uso nella lingua di output selezionata.

{
  "text": "Contenuti originali complessi nella lingua selezionata.",
  "locale": "it",
  "mode": "simple-language"
}

Esempi di SDK e cURL disponibili

Punto di destinazione

POST /api/v2/translate

Crea un risultato Plain Language o Easy Language e restituiscilo nella stessa risposta HTTP.

Titolo richiesto

InseritoriValoreScopo
AuthorizationBearer <API_KEY>Autentica il progetto con lo schema di connessione HTTP corrente
Content-Typedomanda/jsonDeclare il formato del corpo della richiesta
Acceptdomanda/jsonRichiede una risposta JSON
Idempotency-KeyObbligatorio solo per lavori e batchImpedisce che invii asincroni ripetuti creino lavori duplicati

Organismo di richiesta

Nessun'altra impostazione del contenuto fa parte dello schema di richiesta pubblica.

CampoTipo di prodottoRequisitiValore consentitoDescrizione
textstring- Sì, sì.Da 1 a 10.000 caratteri UnicodeContenuto sorgente nella località selezionata
localestring- Sì, sì.Uno dei 24 codici a due lettere supportatiLingua di uscita. La lingua di origine viene rilevata automaticamente.
modestring- Sì, sì.- un linguaggio semplice, facile.Modulo di semplificazione
json
{
  "text": "Applicants must provide the required documentation before the deadline.",
  "locale": "en",
  "mode": "easy-language"
}

Organismo di risposta

La risposta non deve contenere impostazioni della richiesta ritirata o un array separato di informazioni sulla qualità.

CampoTipo di prodottoDescrizione
requestIdstringIdentificatore unico per supporto e registri
localestringLocalità di output selezionata
modestringModalità di semplificazione selezionata
outputstringRisultato finale nella locale di output selezionata
usage.inputCharactersnumero interoI caratteri sono stati contati per questa richiesta o 0 per un riscontro nella cache
usage.cacheHitbooleanoSe il risultato proviene dalla cache di 30 giorni
json
{
  "requestId": "req_sync_002",
  "locale": "en",
  "mode": "easy-language",
  "output": "You need to send documents.\nSend the documents before the deadline.",
  "usage": {
    "inputCharacters": 78,
    "cacheHit": false
  }
}

Comportamento di convalida

  • Mancano testi: respingono con un errore di campo documentato.
  • testo vuoto: respingere con un errore di campo documentato.
  • Locale non supportato: rifiutare; mai sostituire silenziosamente un'altra locale.
  • Modalità non supportata: rifiutare; non scegliere mai una modalità automaticamente.
  • Campo ritirato sconosciuto: respingere con un errore di migrazione o gestire solo attraverso uno strato di compatibilità esplicitamente modificato.
  • Il testo di origine può utilizzare una lingua diversa da quella locale. Simple8 rileva automaticamente la lingua di origine e scrive il risultato nella locale di output selezionata.