Invia un evento

Versione API 2026-10-affable-towhee

post https://api.getlingara.com/v1/events

Comunica a Lingara cosa è successo nel tuo gioco, per esempio che chi impara entra in un luogo nuovo. L'evento viene registrato una sola volta e riceve la risposta 202. Con generate: true Lingara avvia anche un piano di lezione, che richiede lesson_plans:write e ha gli stessi limiti e la stessa fatturazione di POST /v1/lesson-plans: reaction indica il piano, e poi arriva lesson_plan.ready o lesson_plan.failed. Descrivi il mondo, mai il nome o la chat di un giocatore.

Scope events:write

Parametri

Lingara-Versionheaderstringfacoltativo: La versione dell'API con cui rispondere a questa richiesta. Senza di essa, un token di accesso riceve la versione a cui è associato il suo client e una richiesta senza token riceve la versione corrente. La versione ancora in sviluppo si raggiunge solo indicandola qui. Una versione sconosciuta risponde 400 con il codice api_version_unknown. GET /v1/versions elenca le versioni.
Idempotency-Keyheaderstringobbligatorio: Un valore che scegli per ogni evento e riusi quando riprovi: da 1 a 255 caratteri ASCII visibili, per esempio un UUID. Un nuovo tentativo con la stessa chiave riceve la prima risposta e non viene fatturato di nuovo, anche se il contenuto è diverso. Senza una chiave valida la richiesta risponde 400 con il codice idempotency_key_required.

Corpo della richiesta `application/json`

typestringobbligatorio

dataWorldPracticeRequestedobbligatorio

topicstringobbligatorio
source_langstringobbligatorio
target_langstringobbligatorio
levelintegerobbligatorio
tagsarray of stringfacoltativo
generateboolean | nullfacoltativo

Risposte

202 L'evento è registrato

idstringobbligatorio

typestringobbligatorio

created_atstringobbligatorio

reactionReactionReport | nullfacoltativo

statusReactionStatusobbligatorio
plan_idstring | nullfacoltativo
plan_statusPlanStatus | nullfacoltativo: Lo stato del piano quando l'evento è stato accettato. Solo generating promette che seguirà lesson_plan.ready o lesson_plan.failed. Qualsiasi altro valore è un piano fornito dalla libreria, che puoi leggere subito con GET /v1/lesson-plans/{id}.
codestring | nullfacoltativo
errorstring | nullfacoltativo

Errori

402application/json: La chiamata di un client con fatturazione a consumo è stata rifiutata prima che spendesse qualcosa. spend_cap_reached: il client o il suo account ha raggiunto il limite di spesa mensile; alza il limite nella pagina Integrazioni. metered_billing_inactive: la fatturazione a consumo non è attiva per questo account; configurala o aggiorna il metodo di pagamento nella pagina Integrazioni.
410application/json: La versione dell'API con cui si risponde a questa richiesta è stata dismessa. Invia una versione supportata in Lingara-Version, oppure associa il client a un'altra versione.
4XXapplication/json: La richiesta è stata rifiutata. code dice il motivo, e error lo spiega a parole.
503application/json · text/plain: Il servizio è temporaneamente non disponibile; riprova dopo il numero di secondi indicato in Retry-After. Durante la manutenzione il corpo è testo semplice anziché l'envelope di errore.
5XXapplication/json: La richiesta è stata rifiutata. code dice il motivo, e error lo spiega a parole.

codestringobbligatorio: Perché la richiesta è stata rifiutata, come codice stabile su cui diramare la logica: per esempio insufficient_scope (403), rate_limited (429) e, per un client con fatturazione a consumo, spend_cap_reached (402) e metered_billing_inactive (402).
errorstringobbligatorio

Esempio

curl -X POST "https://api.getlingara.com/v1/events" \
  -H "Authorization: Bearer $LINGARA_TOKEN" \
  -H "Idempotency-Key: $IDEMPOTENCY_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"world.context_changed","data":{"scene":"A night market in Taipei, just after rain","npc":{"name":"Auntie Lin","persona":"a street-food vendor who likes to haggle"},"source_lang":"en","target_lang":"zh","level":3,"tags":["market","food","chapter-2"],"generate":true}}'

Preferisci una libreria? Vedi la sezione Librerie.