メインコンテンツへスキップ

Documentation Index

Fetch the complete documentation index at: https://docs.qoder.com/llms.txt

Use this file to discover all available pages before exploring further.

POST /v1/agents/{agent_id}/archive 指定された Agent をアーカイブします。アーカイブ後、Agent はデフォルト一覧には表示されませんが、ID で直接取得することは可能です。

ヘッダー

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

パスパラメータ

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

リクエストボディ

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

リクエスト例

curl -X POST "https://openapi.qoder.sh/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": "API ドキュメントテスト用",
  "model": "ultimate",
  "system": "あなたは更新後のドキュメントテストアシスタントです",
  "instructions": "あなたは更新後のドキュメントテストアシスタントです",
  "tools": [],
  "mcp_servers": [],
  "default_environment": "",
  "version": 2,
  "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システムプロンプト
instructionsstring指示内容
toolsarrayツール設定リスト
mcp_serversarrayMCP サーバー設定
default_environmentstringデフォルトの実行環境
versioninteger現在のバージョン番号
created_atstring作成時刻(ISO 8601)
updated_atstring最終更新時刻(ISO 8601)。アーカイブ時にリフレッシュ

エラーコード

HTTPtypeトリガー条件
401authentication_errorPAT が無効または期限切れ
403permission_errorこの Agent をアーカイブする権限がない
404not_found_error指定 ID の Agent が存在しない

アーカイブと削除の違い

操作効果復元可能
アーカイブ(archive)Agent はデフォルト一覧から非表示、データは保持はい(アーカイブ解除可能)
削除(delete)Agent データは永続的に削除いいえ

注意事項

  • アーカイブはソフト削除操作で、Agent データはシステムに残ります。
  • アーカイブ済み Agent は GET /v1/agents のデフォルト一覧には表示されません。
  • GET /v1/agents/{agent_id} でアーカイブ済み Agent に直接アクセスできます。
  • アーカイブ操作は冪等であり、繰り返しアーカイブしてもエラーは発生しません。