APIリファレンス

規約

すべての /v1/* エンドポイントは Authorization: Bearer sk_... ヘッダーを必要とします。エラーは error フラグと message を持つ JSON として返ります:

{
  "error": true,
  "message": "length must be a positive multiple of 30 seconds, at most 360"
}

生成エンドポイントは 1 分あたり 20 リクエストにレート制限されます。他のすべてのエンドポイントは 1 分あたり 200 の制限を共有します。

解説動画を作成する

生成を開始し、キューに入ったレコードとともに 202 Accepted を返します。ready になるまで 解説動画を取得をポーリングします。

{
  "input": "Explain how DNS resolves a domain name",
  "length": "0:30",
  "aspect": "16:9",
  "voice": "sketchie:sulafat",
  "language": "en"
}

解説動画レコードを返します: id、status、prompt、lengthSeconds、voice、language、aspect、videoUrl（準備完了まで null）、sceneGraph（生成まで null）。source なしの空の input、不正な length、または無効な aspect、preset、fillMode、language の場合は 400 が返ります。

解説動画を取得する

完全なレコードを返します: 現在の status、ready になったときの videoUrl、編集可能な sceneGraph、バージョン履歴（versions）、ヘッドバージョンのシーン chunks。存在しない id は 404 を返します。

解説動画を一覧する

呼び出しキーの解説動画を新しい順に一覧します。キーの所有者にスコープされます。limit は 1〜100 にクランプされます（デフォルト 50）。軽量な要約を返します（scene graph やバージョンなし）。完全なレコードには 解説動画を取得を使用します。

解説動画を編集する

編集可能性のくさび。平易な言葉の指示をターゲットを絞った再レンダリングに変えます。影響を受けるシーンのみが再レンダリングされ、新しいバージョンが生成されます。キューに入ったバージョンとともに 202 を返します。ヘッドバージョンが ready になるまで 解説動画を取得をポーリングします。これは既存の動画に追加されるため、別の無料動画作成枠を消費しません。各動画の最初の再レンダリングは無料です。以降の再レンダリングは有料プランの分数を使用し、無料アカウントはプランの開始を求められます。解説動画はすでに ready でなければなりません（そうでない場合 409）。

{ "instruction": "Make the title scene shorter and warmer" }

バージョンに戻す

ヘッドを以前の準備完了バージョンに再ポイントし、そのグラフと動画をレコードに反映します。ターゲットは動画を持つ ready バージョンでなければなりません（そうでない場合 409）。

{ "versionId": "..." }

ライブステータスストリーム

Server-Sent Events ストリーム（text/event-stream）。1 つの接続を開くと、いずれかの解説動画のあらゆるステータス遷移が event: status フレームとして届くため、ポーリングの代わりにワーカーが完了した瞬間に「動画準備完了」状態を更新できます。ストリームはキーの所有者にスコープされます。

音声

ナレーション音声カタログ。任意の ?language=<code> はその言語をネイティブとする音声にフィルタします。voices（それぞれ分かりやすい name、voice として渡す id、language、isDefault、再生可能な preview_url）とグローバルな default を返します。音声を参照。

言語

サポートされているナレーション言語を { code, label, native } として。すべての code は作成時の有効な language です。言語を参照。

アカウント状態

videosGenerated（生涯）、アカウントの image、isAdmin を返します。認証が必要です。

請求ステータス

認証が必要で、無料アカウントと有料アカウントの両方で 200 を返します。無料アカウントは plan: "free" と videoAllowance、videosUsed、videosRemaining を返します。有料アカウントはさらに planLabel、billingInterval、trialStatus、quotaMinutes、minutesUsedThisPeriod、minutesRemaining、bonusMinutes を返します。

ランタイム設定とヘルス

パブリック。{ "authEnforced": true } を返します。生存確認は GET /health にあります。