Truyền luồng sự kiện

Tham số

Lingara-Versionheaderstringtùy chọn

Phiên bản API dùng để trả lời yêu cầu này. Nếu không có, token truy cập nhận phiên bản mà ứng dụng khách của nó được gắn, còn yêu cầu không có token nhận phiên bản hiện tại. Phiên bản đang phát triển chỉ có thể dùng bằng cách nêu tên nó ở đây. Phiên bản không xác định được trả lời bằng 400 với mã api_version_unknown. GET /v1/versions liệt kê các phiên bản.

Last-Event-IDheaderstringtùy chọn

id: của sự kiện cuối cùng bạn nhận được. Giá trị này được ưu tiên hơn cursor và start.

cursorquerystringtùy chọn

Vị trí tiếp tục: next_cursor của một trang trước, hoặc id: của một sự kiện trong luồng. Con trỏ cũ hơn 30 ngày nhận phản hồi 410 với mã cursor_expired.

startquerystringtùy chọn

Vị trí bắt đầu khi không có con trỏ: latest cho các sự kiện từ bây giờ, hoặc oldest cho mọi sự kiện vẫn còn được lưu.

typesqueryarray of stringtùy chọn

Chỉ các loại sự kiện này, phân tách bằng dấu phẩy. Nếu không có, mọi loại mà phạm vi của token có thể đọc.

Phản hồi

200 Các sự kiện khi chúng xảy ra, cho đến done hoặc error

Sự kiện luồng text/event-stream

Gửi một chú thích keepalive mỗi 15 giây.

event EventEnvelope

idstringbắt buộc

typestringbắt buộc

created_atstringbắt buộc

api_versionstringbắt buộc

subjectstringbắt buộc

dataobjectbắt buộc

done Done Kết thúc luồng

error StreamError Kết thúc luồng

Đến bên trong phản hồi 200. Dòng trạng thái đã được gửi, nên lỗi xảy ra sau khi luồng mở được báo bằng sự kiện này.

codestringbắt buộc

messagestringbắt buộc

plan_idstring | nulltùy chọn

Lỗi

410application/json

api_version_discontinued: phiên bản API của yêu cầu này đã ngừng hoạt động. cursor_expired: con trỏ cũ hơn 30 ngày; hãy bắt đầu lại mà không dùng con trỏ.

4XXapplication/json

Yêu cầu đã bị từ chối. code cho biết lý do, và error diễn đạt lý do đó bằng lời.

503application/json · text/plain

Dịch vụ tạm thời không khả dụng; hãy thử lại sau số giây ghi trong Retry-After. Trong thời gian bảo trì, phần thân là văn bản thuần thay vì phong bì lỗi.

5XXapplication/json

Yêu cầu đã bị từ chối. code cho biết lý do, và error diễn đạt lý do đó bằng lời.

codestringbắt buộc

Lý do yêu cầu bị từ chối, dưới dạng một mã ổn định để rẽ nhánh: ví dụ insufficient_scope (403), rate_limited (429) và, với ứng dụng khách tính phí theo mức dùng, spend_cap_reached (402) và metered_billing_inactive (402).

errorstringbắt buộc

Ví dụ

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

Muốn dùng thư viện? Xem mục Thư viện.

Luồng ví dụ

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