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

重新连接到课程计划

API 版本 2026-10-affable-towhee

get https://api.getlingara.com/v1/lesson-plans/{id}/stream

重新加入仍在生成中的计划的进度流。已完成的计划返回一个 result。仍在生成中但没有可加入的活动流的计划返回一个 pending;请轮询 GET /v1/lesson-plans/{id},直到其完成。

权限范围 lesson_plans:read

参数

Lingara-Versionheaderstring可选
回应此请求所用的 API 版本。不提供时,访问令牌使用其客户端绑定的版本,不带令牌的请求使用当前版本。仍在开发中的版本只能通过在此指定来访问。未知版本会以 400 回应,代码为 api_version_unknown。GET /v1/versions 会列出所有版本。
idpathstring必填

响应

200 计划的剩余进度,然后是计划本身

流事件 text/event-stream

每 15 秒发送一条 keepalive 注释。

started PlanStarted
plan_idstring必填
phase PlanPhase
phasestring必填
attemptinteger必填
result PlanResult 结束数据流
planLessonPlan必填
idstring必填
statusPlanStatus必填
titlestring | null可选
source_langstring必填
target_langstring必填
levelinteger必填
created_atstring必填
completed_atstring | null可选
ai_generatedboolean必填
contentLessonPlanContent | null可选
introductionstring | null可选
learning_objectivesarray of string必填
vocabularyarray of PlanWord必填
wordstring必填
pronunciationstring | null可选
translationstring必填
setsarray of PlanSet必填
numberinteger必填
contextstring | null可选
questionsarray of PlanQuestion必填
typestring必填
promptstring必填
optionsarray of string | null可选
answerstring必填
explanationstring必填
hintstring | null可选
pending PlanPending 结束数据流
plan_idstring必填
statusPlanStatus必填
error StreamError 结束数据流

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

codestring必填
messagestring必填
plan_idstring | null可选

错误

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

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

TypeScript

for await (const ev of client.streamLessonPlan({ id: planId })) {
  if (ev.event === "result") console.log("ready:", ev.data.plan.title);
  if (ev.event === "pending") console.log("still", ev.data.status, "- try again later");
}

Rust

use lingara::models::StreamLessonPlanEvent;

let mut stream = client.stream_lesson_plan(&plan_id).await?;
while let Some(event) = stream.next().await {
    match event? {
        StreamLessonPlanEvent::Result(result) => println!("ready: {}", result.plan.title.unwrap_or_default()),
        StreamLessonPlanEvent::Pending(pending) => println!("still {:?} - try again later", pending.status),
        _ => {}
    }
}

Go

// Rejoin a plan still generating, with the plan_id from its started event.
s, err := client.StreamLessonPlan(ctx, "3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37")
if err != nil {
	return err
}
defer s.Close()
for ev, err := range s.Events() {
	if err != nil {
		return err
	}
	switch e := ev.(type) {
	case lingara.StreamLessonPlanEventResult:
		fmt.Println("ready:", e.Data.Plan.ID)
	case lingara.StreamLessonPlanEventPending:
		fmt.Println("still", e.Data.Status, "- rejoin later")
	}
}

Java

import com.getlingara.client.model.StreamLessonPlanEvent;

try (EventStream<StreamLessonPlanEvent> stream = client.streamLessonPlan(planId)) {
  for (StreamLessonPlanEvent event : stream) {
    if (event instanceof StreamLessonPlanEvent.Result result) {
      System.out.println(result.data().getPlan().getTitle());
    } else if (event instanceof StreamLessonPlanEvent.Pending pending) {
      // Still generating elsewhere: ask again later.
      System.out.println("pending: " + pending.data().getStatus());
    }
  }
}

Kotlin

import com.getlingara.kotlin.LingaraClient
import com.getlingara.kotlin.model.StreamLessonPlanEvent

client.streamLessonPlan(planId).use { stream ->
    stream.collect { event ->
        when (event) {
            is StreamLessonPlanEvent.Result -> println(event.data.plan.title)
            // Still generating elsewhere: ask again later.
            is StreamLessonPlanEvent.Pending -> println("pending: ${event.data.status}")
            else -> Unit
        }
    }
}

Ruby

client.stream_lesson_plan(plan_id) do |event|
  case event
  in Lingara::StreamLessonPlanEventResult => result then puts "ready: #{result.data.plan.title}"
  in Lingara::StreamLessonPlanEventPending => pending then puts "still #{pending.data.status}, try again later"
  else nil
  end
end

PHP

use Lingara\Stream\StreamLessonPlanEvent;

foreach ($client->streamLessonPlan($planId) as $event) {
    if ($event instanceof StreamLessonPlanEvent\Result) {
        echo 'ready: ', $event->data->getPlan()->getTitle(), "\n";
    } elseif ($event instanceof StreamLessonPlanEvent\Pending) {
        echo 'still ', $event->data->getStatus()->value, ", try again later\n";
    }
}

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

流示例

event: pending
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"generating"}

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