更新 Template - Qoder CN 系列

根據 ID 更新 Forward Template。

要求標頭

Header	是否必填	說明
Authorization	是	`Bearer <PAT>`
Content-Type	是	`application/json`
Idempotency-Key	否	有副作用請求可選的等冪鍵。

路徑參數

參數	類型	是否必填	說明
`template_id`	string	是	Forward Template ID。

請求體參數

參數	類型	是否必填	說明
`name`	string	否	新的 Template 名稱。
`description`	string	否	新的 Template 描述。
`model`	string \| object	否	新的模型標識。可傳 string，或傳 Agent model 對象以同時配置 `effort` 或 `context_window`。可通過列出模型介面查詢可用值。
`system`	string	否	新的 System Prompt。
`tools`	array	否	整體替換工具配置列表。
`mcp_servers`	array	否	整體替換 MCP Server 列表。
`skills`	array	否	整體替換 Skill 繫結資料行表。
`multiagent`	object	否	替換 Managed Agents 配置。
`environment_id`	string\|null	否	替換預設 Environment ID；`null` 或Null 字元串表示清空。
`vaults`	object\|null	否	整體替換預設 Vault 配置；按 Vault ID 組織，`null` 表示清空。
`files`	object\|null	否	整體替換預設檔案資源配置；`null` 表示清空。
`environment_variables`	object\|string\|null	否	整體替換預設環境變數；`null` 表示清空。
`metadata`	object	否	合并更新自訂中繼資料。

嵌套設定物件

tools、mcp_servers、skills 都是數組欄位；更新要求中一旦傳入，會整體替換原數組。

Model

model 支援兩種等價形態：直接傳模型 ID 字串，或傳包含模型 ID 和可選調優欄位的對象。

欄位	類型	是否必填	說明
`id`	string	是	模型標識；可通過列出模型介面查詢可用值。
`effort`	string	否	Reasoning effort 等級。可選值：`none`、`low`、`medium`、`high`、`xhigh`、`max`；各模型實際支援的等級見列出模型返回的 `efforts`。
`context_window`	integer	否	期望的上下文視窗（token 數，正整數）；取值請從列出模型返回的 `available_context_windows` 中選擇。

Vaults

vaults 是按 Vault ID 組織的 map。每個配置項支援可選的 enabled boolean；省略等同於 true。更新時傳入 vaults 會整體替換原配置，傳 null 會清空。

{
  "vaults": {
    "vault_019f18f2761b": {
      "enabled": true
    },
    "vault_019f18f2762c": {
      "enabled": true
    }
  }
}

響應統一返回對象形態的 vaults。

檔案資源

files 是按 File ID 組織的 map。配置項內不要再寫 file_id、id 或 resource_id。Forward 在建立 Session 時自動注入 mount_path。

欄位	類型	是否必填	說明
`enabled`	boolean	否	省略等同於 `true`。Identity Config 中可用 `false` 禁用繼承的檔案。

tools 數組項

每個 tools[] 項通過 type 選擇結構。

欄位	類型	適用類型	說明
`type`	string	全部	必填。取值為 `agent_toolset_20260401`、`mcp_toolset` 或 `custom`。
`enabled_tools`	array	`agent_toolset_20260401`	便捷白名單；非空數組表示只啟用這些內建工具。
`disallowed_tools`	array	`agent_toolset_20260401`	便捷禁用列表；編譯為 disabled tool config。
`configs`	array	`agent_toolset_20260401`、`mcp_toolset`	單工具啟用狀態和權限原則。
`mcp_server_name`	string	`mcp_toolset`	必填，必須匹配某個 `mcp_servers[].name`。
`name`	string	`custom`	必填，自訂工具名，不能與內建工具重名。
`description`	string	`custom`	必填，自訂工具描述。
`input_schema`	object	`custom`	必填 JSON Schema，`input_schema.type` 必須為 `object`。

內建工具名包括 Bash、Read、Write、Edit、Glob、Grep、WebFetch、WebSearch、DeliverArtifacts。

Tool config

tools[].configs[] 使用以下結構。

欄位	類型	是否必填	說明
`name`	string	是	工具名；內建工具使用 built-in tool name，MCP toolset 使用 MCP tool name。
`enabled`	boolean	否	`false` 表示隱藏並拒絕該工具；`true` 表示顯式啟用。
`permission_policy`	object	否	運行時許可權行為。

Permission policy

欄位	類型	是否必填	說明
`type`	string	是	`always_allow`、`always_ask` 或 `always_deny`。

MCP servers

欄位	類型	是否必填	說明
`type`	string	否	當前只支援 `http`；省略時 Effective Config 中按 HTTP MCP server 處理。
`name`	string	是	Template 內唯一的 MCP server 名稱，由 `tools[].mcp_server_name` 引用。
`url`	string	是	Streamable HTTP MCP endpoint URL。

skills 數組項

欄位	類型	是否必填	說明
`type`	string	是	`custom` 或 `qoder`。
`skill_id`	string	是	Skill ID。
`version`	string	否	Skill 版本，省略時使用最新版本。
`enabled`	boolean	否	省略等同於 `true`；`false` 表示不進入編譯後的 Agent 配置。

樣本請求

curl -s -X POST 'https://api.qoder.com/api/v1/forward/templates/tmpl_support' \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Support assistant v2",
  "model": {
    "id": "ultimate",
    "effort": "high",
    "context_window": 400000
  },
  "environment_id": "env_support_v2",
  "vaults": {
    "vault_019f18f2761b": {
      "enabled": true
    },
    "vault_019f18f2762c": {
      "enabled": true
    }
  },
  "environment_variables": {
    "BASE_MODE": "support_v2"
  }
}'

樣本響應

HTTP 200 OK

{
  "type": "template",
  "id": "tmpl_support",
  "name": "Support assistant v2",
  "description": "Handles customer support requests",
  "status": "active",
  "model": {
    "id": "ultimate",
    "effort": "high",
    "context_window": 400000
  },
  "system": "You are a helpful support assistant.",
  "tools": [],
  "mcp_servers": [],
  "skills": [],
  "environment_id": "env_support_v2",
  "vaults": {
    "vault_019f18f2761b": {
      "enabled": true
    },
    "vault_019f18f2762c": {
      "enabled": true
    }
  },
  "files": {},
  "environment_variables": {
    "BASE_MODE": "support_v2"
  },
  "metadata": {},
  "created_at": "2026-06-18T10:00:00Z",
  "updated_at": "2026-06-18T10:30:00Z"
}

響應欄位

欄位	類型	說明
傳回值	object	更新後的完整 Template 對象；請求包含 `model` 時按提交形態返回，未包含時保持原有形態。

錯誤

HTTP	Type	Code	觸發條件
400	`invalid_request_error`	-	請求體或欄位取值不合法。
404	`not_found_error`	-	Template 或引用資源不存在。
409	`conflict_error`	-	Template 名稱已存在或狀態衝突。
401	`authentication_error`	`authentication_required`	PAT 無效或已到期。

備忘

歸檔後的 Template 不允許更新。
更新 Session 預設配置不會修改已經存在的 Session。

Qoder CN 系列：更新 Template