メインコンテンツへスキップ
POST /api/v1/cloud/agents/{agent_id}/archive 指定された Agent をアーカイブします。アーカイブ後、Agent はデフォルト一覧に表示されなくなりますが、ID を指定して直接取得することは可能です。

リクエストヘッダー

ヘッダー必須説明
AuthorizationはいBearer <PAT>

パスパラメーター

パラメーター必須説明
agent_idstringはいAgent の一意識別子

リクエストボディ

リクエストボディは不要です。

リクエスト例

curl -X POST "https://api.qoder.com/api/v1/cloud/agents/agent_019eXXXX.../archive" \
  -H "Authorization: Bearer $QODER_PAT"

レスポンス例

HTTP 200 OK
{
  "type": "agent",
  "id": "agent_019eXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "name": "doc-test-agent-updated",
  "description": "Used for API documentation testing",
  "model": "ultimate",
  "system": "You are an updated documentation testing assistant.",
  "tools": [],
  "mcp_servers": [],
  "skills": [],
  "metadata": {},
  "multiagent": null,
  "version": 2,
  "archived_at": "2026-05-18T15:27:22.698411Z",
  "created_at": "2026-05-18T15:26:39.61669Z",
  "updated_at": "2026-05-18T15:27:22.698411Z"
}

レスポンスフィールド

アーカイブ後の完全な Agent オブジェクトを返します。updated_at フィールドはアーカイブ操作の時刻に更新されます。
フィールド説明
typestring固定値 "agent"
idstringAgent の一意識別子
namestringAgent 名
descriptionstringAgent の説明
modelstringモデル識別子
systemstringシステムプロンプト
toolsAgent tool の配列ツール設定リスト
mcp_serversMCP server の配列MCP サーバー設定
skillsSkill binding の配列Skill バインディングリスト
metadataMetadata オブジェクトカスタムメタデータ
multiagentMultiagent | nullAgents 設定、未設定時は null
versioninteger現在のバージョン
archived_atstring|nullアーカイブ時刻(ISO 8601)、未アーカイブ時は null
created_atstring作成時刻(ISO 8601)
updated_atstring最終更新時刻(ISO 8601)、アーカイブ時に更新

エラー

HTTPtype発生条件
401authentication_errorPAT が無効または期限切れ
403permission_errorこの Agent をアーカイブする権限がない
404not_found_error指定された ID の Agent が存在しない
完全なエラーエンベロープについてはエラーを参照してください。

注意事項

  • アーカイブしても Agent のデータは保持されます。
  • アーカイブされた Agent は GET /api/v1/cloud/agents のデフォルト一覧から除外されます。
  • GET /api/v1/cloud/agentsinclude_archived=true を指定すると、アーカイブ済み Agent も一覧に含まれます。
  • アーカイブ済み Agent は GET /api/v1/cloud/agents/{agent_id} で直接取得できます。
  • アーカイブ操作は冪等です。既にアーカイブ済みの Agent を再度アーカイブしてもエラーにはなりません。
  • アーカイブは Agent の version をインクリメントせず、バージョンスナップショットも作成しません。

関連

Agent の定義

再利用可能でバージョン管理された Agent 構成を作成する。