Skip to main content

エージェント CRUD

API キーに紐づくワークスペース内で Agent を作成・取得・更新・削除します。
workspaceIduserId はリクエストで渡しません。API キーのスコープが自動的に適用されます。

共通ヘッダー

GET /api/v1/agent/

Agent の詳細を 1 件取得します。

レスポンス

POST /api/v1/agent

Agent を新規作成します。

リクエストボディ

フィールド

default の挙動

  • 1 体目の Agent は自動で isDefault: true になります
  • isDefault: true で作成すると、同じワークスペース内の既存 default は解除されます

PATCH /api/v1/agent/

Agent を部分更新します。送ったフィールドのみ更新されます。

リクエストボディ

注意

  • isDefault: true を送ると、その Agent が default になります
  • 現在の default Agent に isDefault: false を直接送ることはできません。別 Agent を default にしてください

DELETE /api/v1/agent/

Agent を削除します。関連する AgentRun は cascade で削除されます。

default 削除時の挙動

  • 他の Agent が残っていれば、最新更新の Agent が新しい default に昇格します
  • 残りが 0 件なら default Agent は不在になります

レスポンスフィールド

POST / GET / PATCH / DELETE はすべて同じ Agent オブジェクトを返します。

使用例

エラーレスポンス