Skip to main content
Identities

有効な構成を取得する

Identity と Template に対してコンパイルされたランタイム構成を取得します。

GET /api/v1/forward/identities/{identity_id}/templates/{template_id}/effective Template のベースラインに Identity Config のオーバーライドを適用した後の有効な構成を返します。このレスポンスはランタイム実行向けに設計されており、enabled や op といった Forward DSL フィールドは含まれません。

Headers

HeaderRequiredDescription
AuthorizationYesBearer <PAT または 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
typestring常に effective_spec。
identity_idstringForward Identity ID。
template_idstringForward Template ID。
agent_effective_hashstringコンパイルされた agent セクションのハッシュ。
session_effective_hashstringコンパイルされた session セクションのハッシュ。
effective_hashstring有効な構成全体のハッシュ。
agentobjectコンパイル済み Agent 構成。Agent オブジェクト と以下のフィールド説明を参照してください。
sessionobjectコンパイルされた session のデフォルト値。
session.environment_variablesobject | stringTemplate と Identity Config をマージした最終的な環境変数。

Agent 構成の構造

フィールド型説明
name / descriptionstring名前と説明。構成にない場合は省略されます。
modelstring | objectモデル ID 文字列、または id と任意の effort、speed、context_window を含むオブジェクト。Model を参照してください。
max_tool_roundsintegerTemplate から継承した、1 Turn あたりのツール呼び出しラウンド数の上限。
systemstringreplace / append 適用後の最終プロンプト。mode、content オブジェクトは含まれません。
toolsarrayAgent tool。Tool config と Permission policy を含み、Identity の tools と toolsets のオーバーライドがこの配列にマージされます。
mcp_serversarray各項目は name、type、url を含みます。Template MCP servers を参照。
skillsarraySkill binding:type、skill_id、任意の version。
metadataobjectTemplate の Agent metadata と identity_config.agent_metadata のマージ結果。
multiagentobject | nullMultiagent 設定。{"type":"advisor","model":"ultimate"} を含めることができ、Advisor のモデルは文字列です。Multiagent を参照してください。
生のオーバーライドを読み書きする場合は Identity config object を参照してください。system、tools、mcp_servers、skills などの形式は、このコンパイル済みレスポンスとは異なります。

Errors

HTTPTypeCode発生条件
400invalid_request_error-Effective Config をコンパイルできません。
401authentication_errorauthentication_requiredPAT または SAT が無効または期限切れです。
404not_found_error-Identity または Template が存在しません。
422invalid_request_error-ランタイム構成の検証に失敗しました。

Notes

  • Identity Config は、フィールド固有のマージルールによって Template フィールドをオーバーライドします。
  • Identity Config が存在しない場合は、空のオーバーライドレイヤーとして扱われます。
  • レスポンスには managed_tool_config などの Forward オーバーライド DSL は含まれません。この結果を Upsert Identity Config のリクエストボディとして直接使用しないでください。
  • デフォルトのメモリストアの注入は Session 作成フローによって処理されます。
ベストプラクティス