Stuur 'n gebeurtenis

API-weergawe 2026-10-affable-towhee

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

Vertel Lingara wat in jou speletjie gebeur het, soos dat die leerder 'n nuwe plek binnegaan. Die gebeurtenis word een keer aangeteken en met 202 beantwoord. Met generate: true begin Lingara ook 'n lesplan, wat lesson_plans:write benodig en soos POST /v1/lesson-plans beperk en gefaktureer word: reaction noem die plan, en lesson_plan.ready of lesson_plan.failed volg. Beskryf die wêreld, nooit 'n speler se naam of klets nie.

Omvange events:write

Parameters

Lingara-Versionheaderstringopsioneel: Die API-weergawe waaronder hierdie versoek beantwoord word. Daarsonder kry 'n toegangstoken die weergawe waaraan sy kliënt gekoppel is, en 'n versoek sonder 'n token kry die huidige weergawe. Die weergawe wat nog ontwikkel word, is slegs bereikbaar deur dit hier te noem. 'n Onbekende weergawe gee 400 met kode api_version_unknown. GET /v1/versions lys die weergawes.
Idempotency-Keyheaderstringverplig: 'n Waarde wat jy vir elke gebeurtenis kies en hergebruik wanneer jy dit weer probeer: 1 tot 255 sigbare ASCII-karakters, soos 'n UUID. 'n Herpoging met dieselfde sleutel kry die eerste antwoord terug en word nie weer gefaktureer nie, selfs al verskil die inhoud. Sonder 'n geldige sleutel antwoord die versoek 400 met kode idempotency_key_required.

Versoekliggaam `application/json`

typestringverplig

dataWorldPracticeRequestedverplig

topicstringverplig
source_langstringverplig
target_langstringverplig
levelintegerverplig
tagsarray of stringopsioneel
generateboolean | nullopsioneel

Antwoorde

202 Die gebeurtenis is aangeteken

idstringverplig

typestringverplig

created_atstringverplig

reactionReactionReport | nullopsioneel

statusReactionStatusverplig
plan_idstring | nullopsioneel
plan_statusPlanStatus | nullopsioneel: Die plan se status toe die gebeurtenis aanvaar is. Net generating belowe dat lesson_plan.ready of lesson_plan.failed sal volg. Enige ander waarde is 'n plan uit die biblioteek, wat jy nou met GET /v1/lesson-plans/{id} kan lees.
codestring | nullopsioneel
errorstring | nullopsioneel

Foute

402application/json: 'n Oproep van 'n gemeterde kliënt is geweier voordat dit iets bestee het. spend_cap_reached: die kliënt of sy rekening het sy maandelikse bestedingslimiet bereik; verhoog die limiet op die Integrasies-bladsy. metered_billing_inactive: gebruiksfakturering is nie aktief vir hierdie rekening nie; stel dit op, of werk die betaalmetode by, op die Integrasies-bladsy.
410application/json: Die API-weergawe waaronder hierdie versoek beantwoord word, is gestaak. Stuur 'n ondersteunde weergawe in Lingara-Version, of koppel die kliënt aan 'n ander weergawe.
4XXapplication/json: Die versoek is geweier. code sê hoekom, en error sê dit in woorde.
503application/json · text/plain: Die diens is tydelik onbeskikbaar; probeer weer na die aantal sekondes in Retry-After. Tydens onderhoud is die liggaam gewone teks eerder as die foutomhulsel.
5XXapplication/json: Die versoek is geweier. code sê hoekom, en error sê dit in woorde.

codestringverplig: Waarom die versoek geweier is, as 'n stabiele kode om op te vertak: byvoorbeeld insufficient_scope (403), rate_limited (429) en, vir 'n gemeterde kliënt, spend_cap_reached (402) en metered_billing_inactive (402).
errorstringverplig

Voorbeeld

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}}'

Verkies jy 'n biblioteek? Sien die Biblioteke-afdeling.