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 1つだけで届きます。

スコープ lesson_plans:write

パラメーター

Lingara-Versionheaderstring任意
このリクエストに応答する API バージョン。指定がない場合、アクセストークンはそのクライアントに固定されたバージョンを、トークンのないリクエストは現行バージョンを受け取ります。開発中のバージョンには、ここで指定した場合にのみアクセスできます。不明なバージョンにはコード api_version_unknown とともに 400 を返します。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."}]}]}}}

翻訳と英語版リファレンスの内容が異なる場合は、英語版リファレンスが正しいものとします。