Skip to main content
Identities

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

HeaderRequiredDescription
AuthorizationYesBearer <PAT or SAT>

Path parameters

ParameterTypeRequiredDescription
identity_idstringYesForward Identity ID.
template_idstringYesForward 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

FieldTypeDescription
typestringAlways effective_spec.
agent_effective_hashstringHash of the compiled agent section.
session_effective_hashstringHash of the compiled session section.
effective_hashstringHash of the full effective config.
agentobjectCompiled agent configuration.
sessionobjectCompiled session defaults.
session.environment_variablesobject | stringFinal environment variables after merging the Template and Identity Config.

Errors

HTTPTypeCodeTrigger
400invalid_request_error-The Effective Config cannot be compiled.
401authentication_errorauthentication_requiredThe PAT or SAT is invalid or expired.
404not_found_error-The Identity or Template does not exist.
422invalid_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.
  • Default memory store injection is handled by the Session creation flow.