POST /v1/agents/{agent_id}/archive
指定された Agent をアーカイブします。アーカイブ後、Agent はデフォルト一覧には表示されませんが、ID で直接取得することは可能です。
ヘッダー
| ヘッダー | 必須 | 説明 |
|---|---|---|
| Authorization | はい | Bearer <PAT> |
パスパラメータ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
agent_id | string | はい | Agent の一意識別子 |
リクエストボディ
リクエストボディは不要です。リクエスト例
レスポンス例
HTTP 200 OKレスポンスフィールド
アーカイブ後の完全な Agent オブジェクトを返します。updated_at フィールドはアーカイブ操作時刻に更新されます。
| フィールド | 型 | 説明 |
|---|---|---|
type | string | 固定値 "agent" |
id | string | Agent の一意識別子 |
name | string | Agent 名 |
description | string | Agent の説明 |
model | string | モデル識別子 |
instructions | string | システムプロンプト |
system | string | instructions のエイリアス(非推奨、instructions を使用してください) |
tools | array | ツール設定リスト |
mcp_servers | array | MCP サーバー設定 |
default_environment | string | デフォルトの実行環境 |
version | integer | 現在のバージョン番号 |
created_at | string | 作成時刻(ISO 8601) |
updated_at | string | 最終更新時刻(ISO 8601)。アーカイブ時にリフレッシュ |
エラーコード
| HTTP | type | トリガー条件 |
|---|---|---|
| 401 | authentication_error | PAT が無効または期限切れ |
| 403 | permission_error | この Agent をアーカイブする権限がない |
| 404 | not_found_error | 指定 ID の Agent が存在しない |
アーカイブと削除の違い
| 操作 | 効果 | 復元可能 |
|---|---|---|
| アーカイブ(archive) | Agent はデフォルト一覧から非表示、データは保持 | はい(アーカイブ解除可能) |
| 削除(delete) | Agent データは永続的に削除 | いいえ |
注意事項
- アーカイブはソフト削除操作で、Agent データはシステムに残ります。
- アーカイブ済み Agent は
GET /v1/agentsのデフォルト一覧には表示されません。 GET /v1/agents/{agent_id}でアーカイブ済み Agent に直接アクセスできます。- アーカイブ操作は冪等であり、繰り返しアーカイブしてもエラーは発生しません。