クラウド実行 API の全体像
クラウド実行 API とは
クラウド実行 API は、HTTP でクラウド実行を使うための窓口です。
プロンプトを送ると、クラウドの隔離されたマシンで AI が作業します。
結果は、Git のブランチかテキストで受け取ります。
CI、定期の処理、外部のツールから使うのに向いています。
パソコンの中の Fuga につなぐ fuga-api(ローカル API)とは別のものです。パソコンの Fuga が起動していなくても使えます。
流れ(30 秒)
POST /launchで、1 人の AI に作業を頼みます。計画してチームで進めたいときは、POST /orchestrateを使います。- 返ってきた
runIdでPOST /resultを呼び、終わるまで待ちます。 - Git のブランチか、テキスト(
resultText)を受け取ります。
Base URL と窓口
https://www.kamui.ai/api/cloud
| 窓口 | 何をするか |
|---|---|
POST /launch |
1 人の AI で実行を始める(1 人で実行する)。 |
POST /orchestrate |
計画を立て、チームで分担して実行し、結果を統合する(計画してチームで実行する)。 |
POST /result |
実行の状態と結果を読む(結果と途中経過を見る)。 |
/quota |
1 日の上限と同時実行の上限、使った数を読む。GET でも POST でも呼べる。 |
POST /events |
実行中の計画と進み具合、作業ログを読む(結果と途中経過を見る)。 |
認証のしくみ
どの窓口も、API キーを x-kamui-api-key ヘッダーに入れて呼びます。
AI のログイン情報(認証)は、リクエストに入れません。
デスクトップの Fuga からクラウド金庫に保管した認証を、サーバー側で使います。
そのため、起動のリクエスト(/launch・/orchestrate)には、必ず "serverAuth": true を入れます。
起動のリクエストには、Idempotency-Key ヘッダーも必要です(1 人で実行する)。
章の読み方
最初に「最初の準備(保管庫と API キー)」を済ませてください。
次に「1 人で実行する」の例で試し、「結果と途中経過を見る」で結果を受け取ります。
定期の処理などに組み込む前に、「本番で使うときの注意とエラー」を読んでください。