API概要
Squadbase API の概要 — 認証と Automation の実行エンドポイント。
Squadbase API を使うと、Squadbase で作成した Automation を自社のシステムから実行し、その状態と結果をプログラムから取得できます。すべてのリクエストは以下のベースURLに送信します。
https://api.squadbase.dev/v0認証
すべてのリクエストは、x-api-key ヘッダーに渡すユーザー発行のAPIキーで認証します。キーの作成方法と認可ルールは 認証 を参照してください。
Automation の実行
API による Automation の実行は 非同期（起動してからポーリング）です。
- Automation の実行 — 実行を開始し、
executionIdとstatus: RUNNINGを返します。 - 実行状態の取得 —
executionIdでポーリングして進捗を追跡します。 - 実行結果の取得 — 実行が
COMPLETEDになったら結果を取得します。
| メソッド | エンドポイント | 説明 |
|---|---|---|
POST | /automation/{projectId}/{automationName}/trigger | Automation の実行 |
GET | /automation/{projectId}/{automationName}/executions/{executionId} | 実行状態の取得 |
GET | /automation/{projectId}/{automationName}/executions/{executionId}/result | 実行結果の取得 |
機能概要とユースケースは API から実行する を参照してください。
実行オブジェクト
実行と実行状態の取得は、同じ実行オブジェクトを返します。
Prop
Type
この API は内部の識別子（サンドボックス・チームなど）を返しません。利用者が扱うのは projectId・automationName・executionId のみです。
status の値
| 値 | 意味 |
|---|---|
RUNNING | 実行待ち、または実行中 |
LEASED | 実行中 |
CANCEL_REQUESTED | 停止を受け付け、止めている途中 |
COMPLETED | 成功 |
FAILED | 失敗 |
TIMED_OUT | 実行時間の上限（3 時間）を超えて失敗 |
CANCELLED | 停止 |
COMPLETED・FAILED・TIMED_OUT・CANCELLED が終了状態です。
エラー
すべてのエンドポイントは共通エンベロープ { error, errorCode, message, detail } でエラーを返します。
| HTTP | 条件 |
|---|---|
400 | リクエストボディのバリデーション失敗、Idempotency-Key が 128 文字を超える（実行） |
401 | x-api-key の欠落 / 不正、IP 不許可、system キーの使用、対象プロジェクトがキーのスコープ外 |
402 | AIクレジットの残高が 0（実行） |
422 | Automation が存在しない、executionId が存在しない / path の Automation に属していない、Viewer 権限（viewerCannotEdit）、同じ Automation が実行中（runAlreadyActive） |
429 | API 実行のレート上限を超えた（実行）。Retry-After ヘッダーの秒数だけ待ってから再試行してください |
500 | 実行環境の起動に失敗した場合など |
API での実行は、チームごとに 1 時間あたり 60 回までです（プランによって上限が異なります）。