Identity と Template に対してコンパイルされたランタイム構成を取得します。
GET /api/v1/forward/identities/{identity_id}/templates/{template_id}/effective
Template のベースラインに Identity Config のオーバーライドを適用した後の有効な構成を返します。このレスポンスはランタイム実行向けに設計されており、enabled や op といった Forward DSL フィールドは含まれません。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または SAT> |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
identity_id | string | Yes | Forward Identity ID。 |
template_id | string | Yes | Forward Template ID。 |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
type | string | 常に effective_spec。 |
identity_id | string | Forward Identity ID。 |
template_id | string | Forward Template ID。 |
agent_effective_hash | string | コンパイルされた agent セクションのハッシュ。 |
session_effective_hash | string | コンパイルされた session セクションのハッシュ。 |
effective_hash | string | 有効な構成全体のハッシュ。 |
agent | object | コンパイル済み Agent 構成。Agent オブジェクト と以下のフィールド説明を参照してください。 |
session | object | コンパイルされた session のデフォルト値。 |
session.environment_variables | object | string | Template と Identity Config をマージした最終的な環境変数。 |
Agent 構成の構造
| フィールド | 型 | 説明 |
|---|---|---|
| name / description | string | 名前と説明。構成にない場合は省略されます。 |
model | string | object | モデル ID 文字列、または id と任意の effort、speed、context_window を含むオブジェクト。Model を参照してください。 |
| max_tool_rounds | integer | Template から継承した、1 Turn あたりのツール呼び出しラウンド数の上限。 |
| system | string | replace / append 適用後の最終プロンプト。mode、content オブジェクトは含まれません。 |
| tools | array | Agent tool。Tool config と Permission policy を含み、Identity の tools と toolsets のオーバーライドがこの配列にマージされます。 |
| mcp_servers | array | 各項目は name、type、url を含みます。Template MCP servers を参照。 |
| skills | array | Skill binding:type、skill_id、任意の version。 |
| metadata | object | Template の Agent metadata と identity_config.agent_metadata のマージ結果。 |
multiagent | object | null | Multiagent 設定。{"type":"advisor","model":"ultimate"} を含めることができ、Advisor のモデルは文字列です。Multiagent を参照してください。 |
system、tools、mcp_servers、skills などの形式は、このコンパイル済みレスポンスとは異なります。
Errors
| HTTP | Type | Code | 発生条件 |
|---|---|---|---|
| 400 | invalid_request_error | - | Effective Config をコンパイルできません。 |
| 401 | authentication_error | authentication_required | PAT または SAT が無効または期限切れです。 |
| 404 | not_found_error | - | Identity または Template が存在しません。 |
| 422 | invalid_request_error | - | ランタイム構成の検証に失敗しました。 |
Notes
- Identity Config は、フィールド固有のマージルールによって Template フィールドをオーバーライドします。
- Identity Config が存在しない場合は、空のオーバーライドレイヤーとして扱われます。
- レスポンスには
managed_tool_configなどの Forward オーバーライド DSL は含まれません。この結果を Upsert Identity Config のリクエストボディとして直接使用しないでください。 - デフォルトのメモリストアの注入は Session 作成フローによって処理されます。

