Lingara Lingara 說明文件 學習指南 API 函式庫 App 建立 網頁版
語言: 繁體中文

建立課程計畫

API 版本 2026-10-affable-towhee

post https://api.getlingara.com/v1/lesson-plans

開始產生課程計畫並以串流方式傳回進度。計畫一建立,started 就會提供其識別資訊,因此連線中斷後可以透過 GET /v1/lesson-plans/{id}/stream 重新連線。串流以 result 或 error 結束。來自資料庫的計畫會以單一 result 傳回。

權限範圍 lesson_plans:write

參數

Lingara-Versionheaderstring選填
回應此要求所用的 API 版本。未提供時,存取權杖使用其用戶端綁定的版本,不帶權杖的要求使用目前版本。仍在開發中的版本只能透過在此指定來存取。未知版本會以 400 回應,代碼為 api_version_unknown。GET /v1/versions 會列出所有版本。

要求內文 application/json

contextstring必填
source_langstring必填
target_langstring必填
levelinteger必填

回應

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選填
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

curl -N -X POST "https://api.getlingara.com/v1/lesson-plans" \
  -H "Authorization: Bearer $LINGARA_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"context":"Ordering food at a night market","source_lang":"en","target_lang":"zh","level":2}'

TypeScript

const stream = client.createLessonPlan({
  context: "ordering at a night market",
  source_lang: "en",
  target_lang: "zh",
  level: 2,
});
for await (const ev of stream) {
  if (ev.event === "started") console.log("plan", ev.data.plan_id);
  if (ev.event === "phase") console.log("working:", ev.data.phase);
  if (ev.event === "result") console.log(ev.data.plan.title);
}

Rust

use lingara::models::{CreateLessonPlanEvent, LessonPlanCreateRequest};

let request = LessonPlanCreateRequest {
    context: "ordering at a night market".into(),
    source_lang: "en".into(),
    target_lang: "zh".into(),
    level: 2,
};
let mut stream = client.create_lesson_plan(&request).await?;
while let Some(event) = stream.next().await {
    match event? {
        CreateLessonPlanEvent::Started(started) => println!("plan {}", started.plan_id),
        CreateLessonPlanEvent::Phase(phase) => println!("working: {}", phase.phase),
        CreateLessonPlanEvent::Result(result) => println!("{}", result.plan.title.unwrap_or_default()),
        _ => {}
    }
}

Go

s, err := client.CreateLessonPlan(ctx, lingara.LessonPlanCreateRequest{
	Context:    "ordering at a night market",
	SourceLang: "en",
	TargetLang: "zh",
	Level:      2,
})
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.CreateLessonPlanEventStarted:
		fmt.Println("plan", e.Data.PlanID)
	case lingara.CreateLessonPlanEventPhase:
		fmt.Println("working:", e.Data.Phase)
	case lingara.CreateLessonPlanEventResult:
		if e.Data.Plan.Title != nil {
			fmt.Println(*e.Data.Plan.Title)
		}
	}
}

Java

import com.getlingara.client.model.CreateLessonPlanEvent;
import com.getlingara.client.model.LessonPlanCreateRequest;

LessonPlanCreateRequest request =
    new LessonPlanCreateRequest()
        .context("Ordering at a night market")
        .level(2)
        .sourceLang("en")
        .targetLang("zh");
try (EventStream<CreateLessonPlanEvent> stream = client.createLessonPlan(request)) {
  for (CreateLessonPlanEvent event : stream) {
    if (event instanceof CreateLessonPlanEvent.Started started) {
      // Keep the id: streamLessonPlan rejoins a generation that was cut off.
      System.out.println("plan " + started.data().getPlanId());
    } else if (event instanceof CreateLessonPlanEvent.Phase phase) {
      System.out.println("phase " + phase.data().getPhase());
    } else if (event instanceof CreateLessonPlanEvent.Result result) {
      System.out.println(result.data().getPlan().getTitle());
    }
  }
}

Kotlin

import com.getlingara.kotlin.LingaraClient
import com.getlingara.kotlin.model.CreateLessonPlanEvent
import com.getlingara.kotlin.model.LessonPlanCreateRequest

val request =
    LessonPlanCreateRequest(context = "Ordering at a night market", sourceLang = "en", targetLang = "zh", level = 2)
client.createLessonPlan(request).use { stream ->
    stream.collect { event ->
        when (event) {
            // Keep the id: streamLessonPlan rejoins a generation that was cut off.
            is CreateLessonPlanEvent.Started -> println("plan ${event.data.planId}")
            is CreateLessonPlanEvent.Phase -> println("phase ${event.data.phase}")
            is CreateLessonPlanEvent.Result -> println(event.data.plan.title)
        }
    }
}

Ruby

client.create_lesson_plan(context: "ordering at a night market", source_lang: "en", target_lang: "zh", level: 2) do |event|
  case event
  in Lingara::CreateLessonPlanEventStarted => started then puts "plan #{started.data.plan_id}"
  in Lingara::CreateLessonPlanEventPhase => phase then puts "working: #{phase.data.phase}"
  in Lingara::CreateLessonPlanEventResult => result then puts "ready: #{result.data.plan.title}"
  else nil
  end
end

PHP

use Lingara\Model\LessonPlanCreateRequest;
use Lingara\Stream\CreateLessonPlanEvent;

$request = new LessonPlanCreateRequest([
    'context' => 'ordering at a night market',
    'source_lang' => 'en',
    'target_lang' => 'zh',
    'level' => 2,
]);
foreach ($client->createLessonPlan($request) as $event) {
    if ($event instanceof CreateLessonPlanEvent\Started) {
        echo 'plan ', $event->data->getPlanId(), "\n";
    } elseif ($event instanceof CreateLessonPlanEvent\Phase) {
        echo 'phase: ', $event->data->getPhase(), "\n";
    } elseif ($event instanceof CreateLessonPlanEvent\Result) {
        echo 'ready: ', $event->data->getPlan()->getTitle(), "\n";
    }
}

想用函式庫?請參閱「函式庫」一節。

串流範例

event: started
data: {"plan_id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37"}

event: phase
data: {"phase":"selecting_vocabulary","attempt":1}

event: result
data: {"plan":{"id":"3f1c2a9e-5b7d-4e21-9a0c-6d8e4f2b1a37","status":"complete","title":"At the night market","source_lang":"en","target_lang":"zh","level":2,"created_at":"2026-09-23T10:00:00Z","completed_at":"2026-09-23T10:00:41Z","ai_generated":true,"content":{"introduction":"Order food and ask prices at a night market.","learning_objectives":["Ask how much something costs"],"vocabulary":[{"word":"多少钱","pronunciation":"duōshao qián","translation":"how much"}],"sets":[{"number":1,"questions":[{"type":"multiple_choice_word","prompt":"Which word asks for a price?","options":["多少钱","谢谢"],"answer":"多少钱","explanation":"多少钱 means how much money."}]}]}}}

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