Get effective config

GET /api/v1/forward/identities/{identity_id}/templates/{template_id}/effective Returns the effective configuration after applying Identity Config overrides to the Template baseline. The response is designed for runtime execution and does not include Forward DSL fields such as enabled or op.

Headers

Header	Required	Description
`Authorization`	Yes	`Bearer <PAT or SAT>`

Path parameters

Parameter	Type	Required	Description
`identity_id`	string	Yes	Forward Identity ID.
`template_id`	string	Yes	Forward Template ID.

Example request

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

Example response

HTTP 200 OK

{
  "type": "effective_spec",
  "id": "config_123",
  "identity_id": "idn_019eabc123",
  "template_id": "tmpl_support",
  "agent_effective_hash": "sha256:...",
  "session_effective_hash": "sha256:...",
  "effective_hash": "sha256:...",
  "agent": {
    "model": "ultimate",
    "system": "You are a support assistant.\nPrefer CRM data when answering.",
    "tools": [
      {
        "type": "agent_toolset_20260401",
        "configs": [
          {
            "name": "Read",
            "enabled": true
          },
          {
            "name": "Grep",
            "enabled": true
          },
          {
            "name": "WebSearch",
            "enabled": false
          }
        ]
      }
    ],
    "mcp_servers": [],
    "skills": []
  },
  "session": {
    "environment_id": "env_support",
    "environment_variables": {
      "BASE_MODE": "identity",
      "USER_MODE": "enabled"
    },
    "vault_ids": [
      "vault_019f18f2761b"
    ],
    "resources": [
      {
        "type": "file",
        "file_id": "file_019eXXXX"
      },
      {
        "type": "github_repository",
        "url": "https://github.com/acme/support-agent",
        "mount_path": "/data/workspace/support-agent"
      }
    ]
  }
}

Response fields

Field	Type	Description
`type`	string	Always `effective_spec`.
`agent_effective_hash`	string	Hash of the compiled agent section.
`session_effective_hash`	string	Hash of the compiled session section.
`effective_hash`	string	Hash of the full effective config.
`agent`	object	Compiled Agent configuration. See Agent object and the field descriptions below.
`session`	object	Compiled session defaults.
`session.environment_variables`	object \| string	Final environment variables after merging the Template and Identity Config.

Agent configuration structure

Field	Type	Description
name / description	string	Name and description when present; may be omitted.
`model`	string \| object	Model ID string, or an object containing `id` and optional `effort`, `speed`, and `context_window`. See Model.
max_tool_rounds	integer	Maximum tool-call rounds per Turn inherited from the Template.
system	string	Final prompt compiled using `replace` / `append`; no `mode` or `content` object remains.
tools	array	Agent tool, including Tool config and Permission policy. Identity `tools` and `toolsets` overrides are merged into this array.
mcp_servers	array	Items contain `name`, `type`, and `url`. See Template MCP servers.
skills	array	Skill binding: `type`, `skill_id`, and optional `version`.
metadata	object	Template Agent metadata merged with `identity_config.agent_metadata`.
`multiagent`	object \| null	Multiagent configuration. May include `{"type":"advisor","model":"ultimate"}`; the Advisor model is a string. See Multiagent.

For raw overrides, see Identity config object. Fields such as system, tools, mcp_servers, and skills have different shapes from this compiled response.

Errors

HTTP	Type	Code	Trigger
400	`invalid_request_error`	-	The Effective Config cannot be compiled.
401	`authentication_error`	`authentication_required`	The PAT or SAT is invalid or expired.
404	`not_found_error`	-	The Identity or Template does not exist.
422	`invalid_request_error`	-	Runtime configuration validation failed.

Notes

Identity Config overrides Template fields by field-specific merge rules.
Missing Identity Config is treated as an empty override layer.
The response does not include Forward override DSL fields such as managed_tool_config; do not use it directly as the request body for Upsert Identity Config.
Default memory store injection is handled by the Session creation flow.

Get effective config

Headers

Path parameters

Example request

Example response

Response fields

Agent configuration structure

Errors

Notes

Get identity config

Create a session

​Headers

​Path parameters

​Example request

​Example response

​Response fields

​Agent configuration structure

​Errors

​Notes

​Related

Get identity config

Create a session

Headers

Path parameters

Example request

Example response

Response fields

Agent configuration structure

Errors

Notes

Related