Automation の実行

Automation の新しい実行を開始します。実行を受け付けた時点で 201 Created を返し、Automation はその後バックグラウンドで実行されます。通知のステップがあれば、スケジュール実行と同じように結果が届きます。

リクエストヘッダー

Idempotency-Key を指定すると、ネットワークエラー後に安全に再送できます。同じリクエストの再送には同じキーを、新しい実行には新しいキーを使ってください。

パスパラメータ

リクエストボディ

application/json。空のオブジェクト {} を送ってください。

レスポンス — 201 Created

実行オブジェクト を返します。executionId を保存し、実行状態の取得 と 実行結果の取得 に使います。

{
  "executionId": "uuid",
  "projectId": "uuid",
  "automationName": "daily-sales-alert",
  "status": "RUNNING",
  "title": null,
  "message": null,
  "startedAt": "ISO8601",
  "completedAt": null,
  "createdAt": "ISO8601"
}

呼び出し例

curl -X POST 'https://api.squadbase.dev/v0/automation/<PROJECT_ID>/<AUTOMATION_NAME>/trigger' \
  -H 'x-api-key: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <UNIQUE_KEY>' \
  -d '{}'

同じ Automation が実行中の場合は 422（runAlreadyActive）、レート上限を超えた場合は 429、AIクレジットの残高が 0 の場合は 402 を返します。詳しくは エラー を参照してください。