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

​
Agent オブジェクト

作成、一覧取得、更新、アーカイブ、および version パラメータなしの GET /api/v1/cloud/agents/{agent_id} で返される構造です。
フィールド型説明
idstringAgent ID。プレフィックスは agent_
typestring固定値 "agent"
namestringAgent 名。1〜256 文字
descriptionstringAgent の説明。最大 2048 文字
modelstring | objectモデル識別子。model ID の文字列、または effort と context_window も設定する Agent model オブジェクトを渡します
systemstringシステムプロンプト。最大 100000 文字
toolsAgent tool の配列ツール設定リスト。最大 128 件。デフォルトは []
mcp_serversMCP server の配列MCP サーバーリスト。最大 20 件。デフォルトは []
skillsSkill binding の配列Skill バインディング。最大 20 件。デフォルトは []
metadataobjectMetadata オブジェクト。デフォルトは {}
multiagentMultiagent | nullAgents 設定。未設定時は null を返す
versioninteger現在の Agent バージョン。1 から開始
archived_atstring | nullUTC アーカイブ日時。未アーカイブ時は null
created_atstringUTC 作成日時
updated_atstringUTC 最終更新日時

​
Agent version snapshot

version パラメータ付きの GET /api/v1/cloud/agents/{agent_id} および GET /api/v1/cloud/agents/{agent_id}/versions で返される構造です。
フィールド型説明
idstringAgent ID。プレフィックスは agent_
typestring固定値 "agent"
namestringAgent 名
descriptionstringAgent の説明
modelstring | objectモデル識別子。Agent object と同じ形式。Agent model を参照
systemstringシステムプロンプト
toolsAgent tool の配列ツール設定リスト
mcp_serversMCP server の配列MCP サーバーリスト
skillsSkill binding の配列Skill バインディング
metadataobjectMetadata オブジェクト
multiagentMultiagent | nullAgents 設定
versionintegerこのスナップショットのバージョン番号
archived_atstring | nullUTC アーカイブ日時。このスナップショットが未アーカイブの場合は null
created_atstringAgent の UTC 作成日時
updated_atstringこのスナップショットの UTC 最終更新日時

​
Agent model

Agent の model フィールドは、等価な 2 つの形式を受け付けます:
  • 文字列(簡易形式): モデル ID。例: "ultimate"。
  • オブジェクト形式: id と任意のチューニングフィールドを持つオブジェクト。
フィールド型必須説明
idstringはいモデル識別子。利用可能な値は モデル一覧 で確認できます
effortstringいいえ推論の effort レベル。有効な値: none、low、medium、high、xhigh、max。モデルが提示するレベルは モデル一覧 の efforts 配列を参照
context_windowintegerいいえ希望するコンテキストウィンドウ(トークン数、正の整数)。モデル一覧 の available_context_windows から選択
レスポンスは送信された形式をそのまま返します: 文字列リクエストは model を文字列で、オブジェクトリクエストはチューニングフィールドを保持したオブジェクトで返します。バージョンスナップショット(GET /api/v1/cloud/agents/{agent_id}?version=N)も同じ形式を返します。 Session レスポンスでは Agent が埋め込まれ、agent.model 内に読み取り専用の effective_context_window が追加されます。Session スキーマ を参照してください。

​
Agent tool

tools[] は type によって異なる構造を持つ union 型です。
フィールド型適用タイプ説明
typestringすべて必須。有効な値：agent_toolset_20260401、mcp_toolset、custom
enabled_toolsstring の配列agent_toolset_20260401組み込みツールの許可リスト。空でない配列を指定すると厳密な許可リストとして機能します。省略または [] を渡すとデフォルトの組み込みツールセットが使用され、disallowed_tools と configs[].enabled が引き続き適用されます。値には以下の組み込みツール名を使用してください
disallowed_toolsstring の配列agent_toolset_20260401非表示かつ拒否する組み込みツール。値には以下の組み込みツール名を使用してください。同一ツールを enabled_tools と disallowed_tools の両方に指定することはできません
configsTool config の配列agent_toolset_20260401、mcp_toolsetツールごとの有効化状態と権限ルール。ツール単位の権限はここで permission_policy を通じて設定します
mcp_server_namestringmcp_toolset必須。mcp_servers[].name のいずれかと一致する必要があります
namestringcustom必須のカスタムツール名。組み込みツール名と重複してはならず、mcp__ で始めることもできません
descriptionstringcustom必須のカスタムツールの説明
input_schemaobjectcustom必須の JSON Schema オブジェクト。input_schema.type は "object" でなければなりません
custom ツールは permission_policy をサポートしていません。権限は agent_toolset_20260401 または mcp_toolset の configs[].permission_policy で設定してください。

​
組み込みツール名

以下の組み込みツール名を使用できます：
ツール名
Bash
DeliverArtifacts
Edit
Glob
Grep
Read
WebFetch
WebSearch
Write

​
Tool config

tools[].configs[] で使用します。
フィールド型必須説明
namestringはい設定対象のツール名。agent_toolset_20260401 の場合は組み込みツール名を、mcp_toolset の場合はその MCP サーバーが公開するツール名を使用します
enabledbooleanいいえfalse はそのツールを非表示にし拒否します。true はそのツールを明示的に有効化します
permission_policyPermission policyいいえそのツールの実行時権限動作

​
Permission policy

フィールド型必須説明
typestringはい有効な値：always_allow、always_ask、always_deny
always_allow は一時停止なしで実行します。always_ask は user.tool_confirmation イベントを待って一時停止します。always_deny は拒否されたツール結果を返します。

​
MCP server

mcp_servers[] で使用します。
フィールド型必須説明
namestringはいこの Agent 内で一意の MCP サーバー名
typestringはいサポートされる値："url"
urlstringはいStreamable HTTP MCP エンドポイント URL
MCP サーバーの認証は Vault で設定します。

​
Skill binding

skills[] で使用します。
フィールド型必須説明
typestringはい有効な値：qoder、custom
skill_idstringはいSkill 識別子
versionstringいいえ省略可能な空でないバージョン文字列

​
Multiagent

Agent の multiagent フィールドで使用し、Agents 機能を設定します。設定すると、実行時に coordinator 制御ツール（create_agent、send_to_agent、list_agents、Agent）が自動的に注入されます。
multiagent を使用する場合、tools 配列に agent_toolset_20260401 タイプのエントリを含める必要があります。
フィールド型必須説明
typestringはい"coordinator" でなければなりません
agentsMultiagent agent entry の配列はい委譲可能な Agent のリスト。1〜20 件の一意なエントリ

​
Multiagent agent entry

multiagent.agents[] は 3 つの形式をサポートしています： オブジェクト形式：
フィールド型必須説明
typestringはい"agent" は他の Agent を参照。"self" は coordinator 自身を参照
idstring条件付き必須Agent ID。type が "agent" の場合に必須
versionintegerいいえ特定の Agent バージョンを指定。省略時は最新のアクティブバージョンを使用。正の整数または正の整数文字列をサポート
namestringいいえ子 Agent の表示名
文字列省略形式：Agent ID 文字列を直接渡します。{"type": "agent", "id": "<value>"} と同等です。 例： 
{
  "type": "coordinator",
  "agents": [
    {"type": "agent", "id": "agent_019f00000001", "name": "Research Agent"},
    {"type": "agent", "id": "agent_019f00000002", "version": 3},
    {"type": "self"},
    "agent_019f00000003"
  ]
}

​
関連

Agent の定義

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