Bûyeran biherikîne

Parametre

Lingara-Versionheaderstringvebijarkî

Guhertoya API ya ku ev daxwaz pê tê bersivandin. Bêyî wê, tokena gihîştinê guhertoya ku klientê wê pê ve girêdayî ye distîne, û daxwazeke bê token guhertoya niha distîne. Guhertoya ku hîn di pêşxistinê de ye tenê bi binavkirina wê li vir tê gihîştin. Guhertoyeke nenas bi 400 û koda api_version_unknown tê bersivandin. GET /v1/versions guhertoyan rêz dike.

Last-Event-IDheaderstringvebijarkî

id: ya bûyera dawî ya ku te wergirtiye. Ew li ser cursor û start pêşîn e.

cursorquerystringvebijarkî

Ji ku derê berdewam bikî: next_cursor ya rûpelek berê, an id: ya bûyereke herikînê. Nîşanderê ji 30 rojan kevntir bi 410 û koda cursor_expired tê bersivandin.

startquerystringvebijarkî

Bêyî nîşander ji ku derê dest pê bikî: latest ji bo bûyerên ji niha pê ve, an oldest ji bo her bûyera ku hîn tê parastin.

typesqueryarray of stringvebijarkî

Tenê van cureyên bûyeran, bi bêhnokê veqetandî. Bêyî wê, her cureyê ku qadên tokena te dikarin bixwînin.

Bersiv

200 Bûyer gava ku diqewimin, heta done an error

Bûyerên streamê text/event-stream

Her 15 çirkeyan şîroveyeke keepalive dişîne.

event EventEnvelope

idstringpêwîst

typestringpêwîst

created_atstringpêwîst

api_versionstringpêwîst

subjectstringpêwîst

dataobjectpêwîst

done Done Weşanê diqedîne

error StreamError Weşanê diqedîne

Di nav bersiva 200 de tê. Rêza rewşê berê hatiye şandin, ji ber vê yekê têkçûnek piştî vebûna weşanê wekî vê bûyerê tê ragihandin.

codestringpêwîst

messagestringpêwîst

plan_idstring | nullvebijarkî

Çewtî

410application/json

api_version_discontinued: guhertoya API ya vê daxwazê hatiye rawestandin. cursor_expired: nîşander ji 30 rojan kevntir e; bêyî wê ji nû ve dest pê bike.

4XXapplication/json

Daxwaz hate redkirin. code sedemê dibêje, û error wê bi gotinan dibêje.

503application/json · text/plain

Xizmet bi demkî ne berdest e; piştî hejmara çirkeyên di Retry-After de dîsa biceribîne. Di dema lênêrînê de naverok nivîsa sade ye, ne zerfa çewtiyê.

5XXapplication/json

Daxwaz hate redkirin. code sedemê dibêje, û error wê bi gotinan dibêje.

codestringpêwîst

Çima daxwaz hat redkirin, wek kodeke domdar ku mirov li gorî wê şax dike: bo nimûne insufficient_scope (403), rate_limited (429) û, ji bo klienteke pîvandî, spend_cap_reached (402) û metered_billing_inactive (402).

errorstringpêwîst

Mînak

curl -N "https://api.getlingara.com/v1/events/stream" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

Pirtûkxaneyek tercîh dikî? Beşa Pirtûkxaneyan bibîne.

Mînaka streamê

id: djEuNzQ0MTIuOTkxLjE3OTAyNDk1NjQ
event: event
data: {"id":"lgr_evt_4f2a9c1e7b3d4e5f8a9b0c1d2e3f4a5b","type":"lesson_plan.ready","created_at":"2026-10-01T09:12:44Z","api_version":"2026-09-equipped-boxfish","subject":"lgr_sub_0f1e2d3c4b5a69788796a5b4c3d2e1f0","data":{"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"complete","title":"At the night market","source_lang":"en","target_lang":"zh","level":2}}

id: djEuNzQ0MzAuMC4xNzkwMjUwNDY0
event: done
data: {}