Lingara Lingara 文档 学习指南 API 库 应用 构建 网页版
语言: 中文简体

事件流

API 版本 2026-10-affable-towhee

get https://api.getlingara.com/v1/events/stream

你的客户端可以看到的每个事件一发生就会发送。流在 15 分钟后以 done 结束,或以 error 结束;使用 Last-Event-ID 中最后一个 id: 重新连接,即可无缺口地继续。

权限范围 events:read

参数

Lingara-Versionheaderstring可选
回应此请求所用的 API 版本。不提供时,访问令牌使用其客户端绑定的版本,不带令牌的请求使用当前版本。仍在开发中的版本只能通过在此指定来访问。未知版本会以 400 回应,代码为 api_version_unknown。GET /v1/versions 会列出所有版本。
Last-Event-IDheaderstring可选
你收到的最后一个事件的 id:。它优先于 cursor 和 start。
cursorquerystring可选
从哪里继续:上一页的 next_cursor,或流中某个事件的 id:。超过 30 天的游标会返回 410,代码为 cursor_expired。
startquerystring可选
没有游标时从哪里开始:latest 表示从现在起的事件,oldest 表示仍保留的所有事件。
typesqueryarray of string可选
仅这些事件类型,以逗号分隔。省略时,为你的令牌作用域可以读取的所有类型。

响应

200 实时发生的事件,直到 done 或 error

流事件 text/event-stream

每 15 秒发送一条 keepalive 注释。

event EventEnvelope
idstring必填
typestring必填
created_atstring必填
api_versionstring必填
subjectstring必填
dataobject必填
done Done 结束数据流
error StreamError 结束数据流

在 200 响应内送达。状态行已经发送,因此数据流打开后的失败会以此事件报告。

codestring必填
messagestring必填
plan_idstring | null可选

错误

410application/json
api_version_discontinued:此请求的 API 版本已停用。cursor_expired:游标已超过 30 天;请不带游标重新开始。
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 "https://api.getlingara.com/v1/events/stream" \
  -H "Authorization: Bearer $LINGARA_TOKEN"

更喜欢用库?请参阅“库”部分。

流示例

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

如译文与英文参考文档不一致,以英文参考文档为准。