すべてのプロダクト
Search
ドキュメントセンター

Qoder CN シリーズ:エージェントのアーカイブ

最終更新日:Jul 04, 2026

エージェントをアーカイブして、ID でアクセス可能な状態を保ったまま、デフォルトの一覧から非表示にします。

リクエストヘッダー

ヘッダー

必須

説明

Authorization

はい

Bearer <PAT>

パスパラメーター

パラメーター

タイプ

必須

説明

agent_id

文字列

はい

一意のエージェント識別子。

リクエストボディ

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

リクエスト例

curl -X POST "https://api.qoder.com.cn/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 the updated documentation testing assistant.",
  "instructions": "You are the updated documentation testing assistant.",
  "tools": [],
  "mcp_servers": [],
  "default_environment": "",
  "version": 2,
  "created_at": "2026-05-18T15:26:39.61669Z",
  "updated_at": "2026-05-18T15:27:22.698411Z"
}

レスポンスフィールド

アーカイブ後の完全なエージェントオブジェクトを返します。 updated_at フィールドは、アーカイブ操作の時刻に更新されます。

フィールド

タイプ

説明

type

文字列

常に "agent" です。

id

文字列

一意のエージェント識別子。

name

文字列

エージェント名。

description

文字列

エージェントの説明。

model

文字列

モデル識別子。

instructions

文字列

システムプロンプト。

system

文字列

instructions のエイリアスです。非推奨です。instructions を使用してください。

tools

配列

ツール設定。

mcp_servers

配列

MCP サーバー設定。

default_environment

文字列

デフォルトのランタイム環境。

version

整数

現在のバージョン番号。

created_at

文字列

ISO 8601 形式の作成時刻。

updated_at

文字列

ISO 8601 形式の最終更新時刻。アーカイブ時に更新されます。

エラー

HTTP

タイプ

トリガー

401

authentication_error

PAT が無効であるか、有効期限が切れています。

403

permission_error

呼び出し元に、このエージェントをアーカイブする権限がありません。

404

not_found_error

指定された ID のエージェントは存在しません。

エラーエンベロープ全体については、 Errors をご参照ください。

アーカイブと削除の比較

アクション

影響

復元可否

アーカイブ

エージェントはデフォルトの一覧から非表示になります。データは保持されます。

はい (アンアーカイブ可能)。

削除

エージェントは完全に削除されます。

いいえ。

注記

  • アーカイブは論理削除です。エージェントのデータはシステム内に残ります。

  • アーカイブされたエージェントは、GET /v1/agents のデフォルトのレスポンスから除外されます。

  • アーカイブされたエージェントは、依然として GET /v1/agents/{agent_id} を使用して取得できます。

  • この操作はべき等です。すでにアーカイブ済みのエージェントをアーカイブしても、エラーは発生しません。