Skip to main content

Get effective config

Returns the final runtime configuration compiled by merging an Identity and a Template.

Request headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT>

Path parameters

ParameterTypeRequiredDescription
identity_idstringYesForward Identity ID.
template_idstringYesForward Template ID.

Example request

curl -s -X GET 'https://api.qoder.com.cn/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

FieldTypeDescription
typestringAlways effective_spec.
identity_idstringForward Identity ID.
template_idstringForward Template ID.
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.

Errors

HTTPTypeTrigger
400invalid_request_errorEffective config cannot be compiled.
401TOKEN_INVALIDPAT invalid or expired.
404not_found_errorIdentity or Template does not exist.
422invalid_request_errorRuntime configuration is invalid.

Notes

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