跳转到主要内容
POST /api/v1/forward/templates Template 定义创建 Session 时使用的默认 Agent 配置和 Session 默认配置。

​
请求头

Header是否必填说明
Authorization是Bearer <PAT>
Content-Type是application/json
Idempotency-Key否有副作用请求可选的幂等键。

​
请求体参数

参数类型是否必填说明
namestring是Template 名称，1-256 个字符，租户内唯一。
modelstring是模型标识，例如 ultimate。
environment_idstring是创建 Session 时默认使用的 Environment ID。
descriptionstring否Template 描述，最多 2048 个字符。
systemstring否System Prompt，最多 100,000 个字符。
toolsarray否工具配置列表，最多 128 项。
mcp_serversarray否MCP Server 配置列表，最多 20 项。
skillsarray否Skill 绑定列表，最多 20 项。
multiagentobject否Managed Agents 配置。
vault_idsarray否默认 Vault ID 列表。
filesobject否默认文件资源配置，按 file ID 组织。
environment_variablesobject | string否默认 Session 环境变量。
metadataobject否自定义元数据。

​
嵌套配置对象

​
文件资源

files 是按 File ID 组织的 map。配置项内不要再写 file_id、id 或 resource_id。Forward 在创建 Session 时自动注入 mount_path。
字段类型是否必填说明
enabledboolean否省略等同于 true。Identity Config 中可用 false 禁用继承的文件。

​
tools 数组项

每个 tools[] 项通过 type 选择结构。
字段类型适用类型说明
typestring全部必填。取值为 agent_toolset_20260401、mcp_toolset 或 custom。
enabled_toolsarrayagent_toolset_20260401便捷白名单；非空数组表示只启用这些内置工具。
disallowed_toolsarrayagent_toolset_20260401便捷禁用列表；编译为 disabled tool config。
configsarrayagent_toolset_20260401、mcp_toolset单工具启用状态和权限策略。
mcp_server_namestringmcp_toolset必填，必须匹配某个 mcp_servers[].name。
namestringcustom必填，自定义工具名，不能与内置工具重名。
descriptionstringcustom必填，自定义工具描述。
input_schemaobjectcustom必填 JSON Schema，input_schema.type 必须为 object。
内置工具名包括 Bash、Read、Write、Edit、Glob、Grep、WebFetch、WebSearch、DeliverArtifacts。

​
Tool config

tools[].configs[] 使用以下结构。
字段类型是否必填说明
namestring是工具名；内置工具使用 built-in tool name，MCP toolset 使用 MCP tool name。
enabledboolean否false 表示隐藏并拒绝该工具；true 表示显式启用。
permission_policyobject否运行时权限行为。

​
Permission policy

字段类型是否必填说明
typestring是always_allow、always_ask 或 always_deny。

​
MCP servers

字段类型是否必填说明
typestring否当前只支持 http；省略时 Effective Config 中按 HTTP MCP server 处理。
namestring是Template 内唯一的 MCP server 名称，由 tools[].mcp_server_name 引用。
urlstring是Streamable HTTP MCP endpoint URL。

​
skills 数组项

字段类型是否必填说明
typestring是custom 或 qoder。
skill_idstring是Skill ID。
versionstring否Skill 版本，省略时使用最新版本。
enabledboolean否省略等同于 true；false 表示不进入编译后的 Agent 配置。

​
示例请求

curl -s -X POST 'https://api.qoder.com/api/v1/forward/templates' \
  -H "Authorization: Bearer $QODER_PAT" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Support assistant",
  "description": "Handles customer support requests",
  "model": "ultimate",
  "system": "You are a helpful support assistant.",
  "tools": [],
  "mcp_servers": [],
  "skills": [],
  "environment_id": "env_support",
  "vault_ids": [
    "vault_crm"
  ],
  "files": {},
  "environment_variables": {
    "BASE_MODE": "support"
  },
  "metadata": {}
}'

​
示例响应

HTTP 200 OK 
{
  "type": "template",
  "id": "tmpl_support",
  "name": "Support assistant",
  "description": "Handles customer support requests",
  "status": "active",
  "model": "ultimate",
  "system": "You are a helpful support assistant.",
  "tools": [],
  "mcp_servers": [],
  "skills": [],
  "environment_id": "env_support",
  "vault_ids": [
    "vault_crm"
  ],
  "files": {},
  "environment_variables": {
    "BASE_MODE": "support"
  },
  "metadata": {},
  "created_at": "2026-06-18T10:00:00Z",
  "updated_at": "2026-06-18T10:00:00Z"
}

​
响应字段

字段类型说明
typestring固定为 template。
idstringTemplate ID。
statusstringactive 或 archived。
environment_idstring默认 Environment ID。
vault_idsarray默认 Vault ID 列表。
filesobject默认文件资源配置。

​
错误

HTTPTypeCode触发条件
400invalid_request_error-请求体或字段取值不合法。
404not_found_error-引用的 Environment、Skill、Vault 或 File 不存在。
409conflict_error-Template 名称已存在。
401authentication_errorauthentication_requiredPAT 无效或已过期。

​
注意事项

  • 创建时不要传 template_id，ID 由 Forward 生成。
  • files 使用 file ID 作为 map key，配置项内不要重复写 file_id、id 或 resource_id。
  • Forward 在创建 Session 时自动补充文件挂载路径。

​
相关

列出 Templates

创建 Session