Skip to main content
Templates

Get a template

Retrieve a Forward template by ID.

GET /api/v1/forward/templates/{template_id} Returns the complete template object, including agent configuration and session defaults.

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT or SAT>

Path parameters

ParameterTypeRequiredDescription
template_idstringYesForward Template ID.

Example request

curl -s -X GET 'https://api.qoder.com.cn/api/v1/forward/templates/tmpl_support' \
  -H "Authorization: Bearer $QODER_ACCESS_TOKEN"

Example response

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": [],
  "managed_tool_config": {
    "enabled_tools": []
  },
  "mcp_servers": [],
  "skills": [],
  "environment_id": "env_support",
  "vaults": {
    "vault_019f18f2761b": {
      "enabled": true
    }
  },
  "files": {},
  "github_repositories": {
    "source": {
      "url": "https://github.com/acme/support-agent",
      "mount_path": "/data/workspace/support-agent"
    }
  },
  "environment_variables": {
    "BASE_MODE": "support"
  },
  "metadata": {},
  "created_at": "2026-06-18T10:00:00Z",
  "updated_at": "2026-06-18T10:00:00Z"
}

Response fields

FieldTypeDescription
typestringAlways template.
idstringTemplate ID.
namestringTemplate name.
statusstringactive or archived.
modelstring | objectModel ID string, or an object containing id and optional effort, speed, and context_window. See Model.
max_tool_roundsintegerMaximum tool-call rounds per Turn.
multiagentobject | nullMulti-agent configuration. May include {"type":"advisor","model":"ultimate"}; the Advisor model is a string. See Multiagent.
managed_tool_configobjectForward managed-capability baseline for the Template. When configured, it is returned as an enabled_tools array.
vaultsobjectDefault Vault configuration keyed by Vault ID.
github_repositoriesobjectDefault GitHub repository configuration, including normalized url and final mount_path; excludes authorization_token.
systemstringSystem prompt.
environment_idstringDefault Environment ID.
metadataobjectCustom metadata.

Errors

HTTPTypeCodeTrigger
403permission_error-Not authorized for this resource.
404not_found_error-Template does not exist or is not visible to the caller.
401authentication_error-The PAT or SAT is invalid or expired.

Notes

  • Archived templates can still be retrieved by ID.
  • managed_tool_config.enabled_tools is the complete Template baseline. Query Identity Config for Identity-level individual overrides.
  • schedule enables the three Forward managed capabilities for creating, listing, and deleting Schedules together; drive represents the complete Drive capability. Responses preserve these configuration selectors without expanding them into execution tool names.
  • Runtime-only Qoder Cloud Agents fields are not added to this response.
  • github_repositories.*.authorization_token is write-only and is never included in Template responses.

Update a template

Archive a template