API概要

Squadbase API を使うと、Squadbase上で作成したエージェントを自社のシステムから実行し、その結果をプログラムから取得できます。すべてのリクエストは以下のベースURLに送信します。

https://api.squadbase.dev/v0

利用者が扱う識別子は エージェントID（agentId）と 実行ID（executionId）の2つだけです。内部の識別子は一切公開されません。

認証

すべてのリクエストは、x-api-key ヘッダーに渡すユーザー発行のAPIキーで認証します。キーの作成方法と認可ルールは 認証 を参照してください。

エージェントの実行

API 経由でのエージェント実行は 非同期（fire-and-poll）です。

1. エージェントの実行 — 実行を開始し、executionId と status: RUNNING を返します。
2. 実行状態の取得 — executionId でポーリングして進捗を追跡します。
3. 実行結果の取得 — 実行が COMPLETED になったら最終出力を取得します。

機能概要とユースケースは エージェントをAPIでトリガーする を参照してください。

実行オブジェクト

トリガーと実行状態の取得は、同じ実行オブジェクトを返します。

status の値 — 実行は以下を遷移します。

RUNNING · LEASED · CANCEL_REQUESTED · COMPLETED · FAILED · TIMED_OUT · CANCELLED

エラー

すべてのエンドポイントは共通エンベロープ { error, errorCode, message, detail } でエラーを返します。