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: {}

如譯文與英文參考文件有出入,以英文參考文件為準。