Lingara Lingara 說明文件 學習指南 API 程式庫 App 建立 嵌入 網頁版
語言: 粵語

傳一句說話畀 NPC

API 版本 2026-10-virile-dragon

post https://api.getlingara.com/v1/embed/dialogue/turns

將玩家嘅 line 傳畀一個角色,再將角色嘅回覆用 delta 事件串流出嚟,以 done 結束。角色淨係講 target_lang,跟玩家嘅 level。乜都唔會儲存:將到而家嘅對話放喺 history 傳過嚟。每一輪都計落一個 metered 用戶端;其他呼叫者會收到 403 embed_needs_metered。

權限範圍 embed:play

參數

Lingara-Versionheaderstring選填
回應呢個請求所用嘅 API 版本。冇呢個嘅話,存取權杖會用佢嘅用戶端綁定嘅版本,冇權杖嘅請求會用而家嘅版本。仲喺開發中嘅版本,只可以喺度指明先用到。唔認得嘅版本會回 400,代碼係 api_version_unknown。GET /v1/versions 會列出所有版本。

請求內容 application/json

npcNpc必填
namestring必填
personastring | null選填
scenestring | null選填
source_langstring必填
target_langstring必填
levelinteger必填
linestring必填
historyarray of DialogueEntry選填

到而家嘅對話,舊嘅行先,最多 12 行。窗口由你保管:Lingara 喺輪與輪之間乜都唔儲存。將 NPC 每句回覆截到頭 500 個字先傳返嚟。

speakerSpeaker必填
textstring必填

回應

200 角色嘅回覆,一段一段

串流事件 text/event-stream

唔會送出 keepalive 註解。

delta TurnDelta
textstring必填
notice Notice
codestring必填
messagestring必填
done Done 結束串流
error StreamError 結束串流

喺 200 回應入面到達。狀態行已經送出,所以串流開咗之後嘅失敗會以呢個事件報告。

codestring必填
messagestring必填
plan_idstring | null選填

錯誤

402application/json
一個按用量收費嘅用戶端嘅呼叫,喺佢用任何嘢之前已經被拒絕。spend_cap_reached:用戶端或者佢嘅帳戶已經到咗每月嘅支出上限;請喺整合頁面調高上限。metered_billing_inactive:呢個帳戶嘅按用量收費未啟用;請喺整合頁面設定,或者更新付款方式。
410application/json
回應呢個請求所用嘅 API 版本已經停用。請喺 Lingara-Version 傳一個有支援嘅版本,或者將用戶端綁去另一個版本。
4XXapplication/json
請求被拒絕。code 講出原因,error 用文字解釋。
503application/json · text/plain
服務暫時用唔到;請等 Retry-After 入面嘅秒數之後再試。維護期間,回應內容係純文字,而唔係錯誤封包。
5XXapplication/json
請求被拒絕。code 講出原因,error 用文字解釋。
codestring必填

請求被拒絕嘅原因,係一個穩定嘅代碼,可以用嚟做分支處理:例如 insufficient_scope(403)、rate_limited(429),對按用量收費嘅用戶端仲有 spend_cap_reached(402)同 metered_billing_inactive(402)。

errorstring必填

例子

curl -N -X POST "https://api.getlingara.com/v1/embed/dialogue/turns" \
  -H "Authorization: Bearer $LINGARA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"npc":{"name":"Auntie Lin","persona":"a street-food vendor who likes to haggle"},"scene":"A night market in Taipei, just after rain","source_lang":"en","target_lang":"zh","level":3,"line":"How much are the dumplings?","history":[{"speaker":"npc","text":"来来来,刚出锅的饺子!"},{"speaker":"player","text":"你好!"}]}'

想用程式庫?睇吓程式庫部分。

串流例子

event: delta
data: {"text":"饺子十块钱一盘,"}

event: delta
data: {"text":"要几盘?"}

event: done
data: {}

如果譯本同英文參考文件有出入,以英文參考文件為準。