エージェントの実行

エージェントの新しい実行を開始します。実行レコードを作成しサンドボックスを起動した時点で 201 Created を返し、実処理は裏でエージェント基盤が進めて、完了後に設定済みの通知先へ結果を配信します。

リクエストヘッダー

x-api-key ヘッダーはすべてのリクエストで必須です。詳細は 認証 を参照してください。なお、このエンドポイントはJSONボディを受け取るため、Content-Type: application/json も指定してください。

Idempotency-Key を指定すると、ネットワークエラー後にトリガーを安全に再送しても実行が重複する心配がありません。同一の論理リクエストの再送には同じキーを、まったく新しい実行には新しいキーを使用してください。キーはAPIキーごとにスコープされます。

パスパラメータ

リクエストボディ

application/json。いずれのフィールドも任意です。

{
  "message": "今週のサインアップ動向を分析して",
  "title": "週次サインアップ分析"
}

レスポンス — 201 Created

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

{
  "executionId": "uuid",        // 状態 / 結果取得に使うハンドル
  "agentId": "uuid",
  "status": "RUNNING",
  "title": "週次サインアップ分析",
  "message": "今週のサインアップ動向を分析して",
  "startedAt": "ISO8601",
  "completedAt": null,
  "createdAt": "ISO8601"
}

呼び出し例

curl -X POST 'https://api.squadbase.dev/v0/agent/<AGENT_ID>/trigger' \
  -H 'x-api-key: <YOUR_API_KEY>' \
  -H 'Content-Type: application/json' \
  -H 'Idempotency-Key: <UNIQUE_KEY>' \
  -d '{"message":"今週のサインアップ動向を分析して","title":"週次分析"}'

エラーレスポンスは エラー を参照してください。