Get effective config

Get the compiled runtime config for an Identity and Template.

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>

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_PAT"

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 },
          { "name": "WebFetch", "enabled": true }
        ]
      }
    ],
    "mcp_servers": [
      {
        "name": "mcp_crm",
        "type": "http",
        "url": "https://crm.example.com/mcp"
      }
    ],
    "skills": [
      {
        "type": "custom",
        "skill_id": "skill_customer_reply",
        "version": "1"
      }
    ]
  },
  "session": {
    "environment_id": "env_support",
    "vault_ids": ["vault_crm"],
    "resources": [
      {
        "type": "file",
        "file_id": "file_019eXXXX",
        "mount_path": "/data/policy.md"
      }
    ]
  }
}

Response fields

Field	Type	Description
type	string	Always effective_spec.
identity_id	string	Forward Identity ID.
template_id	string	Forward Template ID.
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.
session	object	Compiled session defaults.

Errors

HTTP	Type	Trigger
400	invalid_request_error	Effective config cannot be compiled.
401	authentication_error	PAT invalid or expired.
404	not_found_error	Identity or Template does not exist.
422	invalid_request_error	Runtime configuration is invalid.

Notes

• Identity Config overrides Template fields by field-specific merge rules.
• Missing Identity Config is treated as an empty override layer.
• Default memory store injection is handled by the Session creation flow.

Related

Get identity config

Create a session