Lingara Lingara 說明文件 學習指南 API 函式庫 應用程式 起造 網頁版
語言: 閩南語

建立課程計畫

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."}]}]}}}

若是翻譯佮英文參考文件無仝,就以英文參考文件為準。