Forward テンプレートを ID で更新します。
POST /api/v1/forward/templates/{template_id}
変更可能なテンプレートフィールドを更新します。リクエストから省略されたフィールドは変更されません。tools、mcp_servers、skills などの配列フィールドは、指定された場合は全体が置き換えられます。
Headers
| Header | Required | Description |
|---|---|---|
Authorization | Yes | Bearer <PAT または SAT> |
Content-Type | Yes | application/json |
Idempotency-Key | No | 安全でないリクエストに対する任意の冪等性キー。 |
X-Qoder-Beta | Browser Use を使用する場合 | 更新後の tools に Browser Use ツールセットが含まれる場合、browser-use-2026-07-14 を指定する必要があります。 |
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
template_id | string | Yes | Forward の Template ID。 |
Body parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
name | string | No | 新しいテンプレート名。 |
description | string | No | 新しいテンプレートの説明。 |
model | string|object | No | 新しいモデル ID、またはモデル ID と任意の調整フィールドを含むオブジェクト。 |
system | string | No | 新しいシステムプロンプト。 |
tools | array | No | ツール設定のリストを置き換えます。 |
mcp_servers | array | No | MCP サーバーのリストを置き換えます。 |
skills | array | No | Skill のバインディングリストを置き換えます。 |
multiagent | object|null | No | Multi-agent 設定を置き換えます。null でクリアし、省略すると現在の設定を保持します。 |
environment_id | string|null | No | デフォルトの Environment ID を置き換えます。null または空文字列を指定するとクリアされます。 |
vaults | object|null | No | デフォルトの Vault 設定全体を置き換えます。null でクリアします。 |
files | object|null | No | デフォルトのファイルリソースを置き換えます。null を指定するとマップがクリアされます。 |
github_repositories | object|null | No | デフォルトの GitHub リポジトリ設定全体を置き換えます。null または空のオブジェクトで全 binding をクリアします。 |
environment_variables | object | string|null | No | デフォルトのセッション環境変数を置き換えます。null を指定するとクリアされます。 |
metadata | object | No | カスタムメタデータをマージして更新します。 |
Nested configuration objects
tools、mcp_servers、skills は配列フィールドです。更新リクエストで指定された場合、各配列は以前の配列を全体として置き換えます。
Model
model にはモデル ID の文字列、またはモデル ID と任意の調整フィールドを含むオブジェクトを指定できます。
| Field | Type | Required | Description |
|---|---|---|---|
id | string | Yes | モデル識別子。利用可能な値は List models エンドポイントで確認できます。 |
effort | string | No | Reasoning effort。none、low、medium、high、xhigh、max のいずれか。各モデルが対応する値は efforts を確認してください。 |
context_window | integer | No | 希望するコンテキストウィンドウの token 数。モデルの available_context_windows に含まれる正の整数を指定します。 |
Vaults
vaults は Vault ID をキーとするマップです。各項目には任意の enabled boolean を指定でき、省略時は true と同じです。vaults を指定すると既存設定全体を置き換え、null でクリアします。
vaults が常にオブジェクト形式で返されます。
File resources
files は File ID をキーとするマップです。各項目の内部に file_id、id、resource_id を含めないでください。Forward は Session の作成時に mount_path を注入します。
| Field | Type | Required | Description |
| enabled | boolean | No | デフォルトは true。false にすると、Identity Config で継承されたファイルが無効になります。 |
GitHub repositories
github_repositories は binding key をキーとするマップです。binding key は [A-Za-z][A-Za-z0-9_-]{0,63} に一致する必要があり、最大 20 件まで指定できます。正規化後のリポジトリ URL と mount path は重複できません。
| Field | Type | Required | Description |
|---|---|---|---|
url | string | Yes | 絶対 HTTPS リポジトリ URL。userinfo、query、fragment、パーセントエンコード、バックスラッシュは使用できず、末尾の .git は正規化時に削除されます。 |
authorization_token | string | Yes | 書き込み専用のリポジトリアクセストークン。レスポンスには返されません。最大 8192 bytes で、ASCII の英字、数字、アンダースコアのみ使用できます。 |
mount_path | string | No | Session 内の正規化された絶対 mount path。/ は指定できません。省略時は /data/workspace/<repository-name> です。github_repositories フィールド全体を省略した場合、既存の構成は保持されます。 |
| リクエスト形式 | セマンティクス |
|---|---|
| フィールドを省略 | 現在のリポジトリ設定を保持します。 |
github_repositories: null | すべての binding をクリアします。 |
github_repositories: {} | すべての binding をクリアします。 |
| 空でないオブジェクト | リポジトリ設定全体を置き換えます。 |
Tools array
各 tools[] の項目は type によって選択されます。
| Field | Type | Applies to | Description |
|---|---|---|---|
type | string | All | 必須。agent_toolset_20260401、browser_toolset_20260714、mcp_toolset、または custom。 |
enabled_tools | array | agent_toolset_20260401 | 便宜的な許可リスト。空でないリストを指定すると、これらの組み込みツールのみが有効になります。 |
disallowed_tools | array | agent_toolset_20260401 | 便宜的な拒否リスト。無効化されたツール設定にコンパイルされます。 |
configs | array | agent_toolset_20260401, mcp_toolset | ツールごとの有効化と権限ポリシー。 |
mcp_server_name | string | mcp_toolset | 必須。mcp_servers[].name のいずれかの項目と一致する必要があります。 |
name | string | custom | 必須のカスタムツール名。組み込みツールと競合してはいけません。 |
description | string | custom | 必須のカスタムツールの説明。 |
input_schema | object | custom | 必須の JSON Schema。input_schema.type は object である必要があります。 |
Bash、Read、Write、Edit、Glob、Grep、WebFetch、WebSearch、DeliverArtifacts です。
Browser Use(Beta)
Browser Use は現在 Beta 機能であり、機能、制限、API の詳細は変更される可能性があります。
Browser Use を有効にするには、次の toolset を tools に追加します:
tools は配列全体を置き換えます。既存の toolset を保持するには、browser_toolset_20260714 と一緒に新しい tools 配列へ含めてください。
Tool config
tools[].configs[] の項目はこの形式を使用します。
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | ツール名。agent_toolset_20260401 の場合は組み込みツール名、mcp_toolset の場合は MCP ツール名。 |
enabled | boolean | No | false にするとツールを非表示にして拒否します。true にすると明示的に有効化します。 |
permission_policy | object | No | 実行時の権限の挙動。 |
Permission policy
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | always_allow、always_ask、または always_deny。 |
MCP servers
| Field | Type | Required | Description |
|---|---|---|---|
type | string | No | 現在は http のみ。省略された値は Effective Config で HTTP MCP サーバーとして扱われます。 |
name | string | Yes | Template 内で一意の MCP サーバー名。tools[].mcp_server_name から参照されます。 |
url | string | Yes | Streamable HTTP MCP エンドポイントの URL。 |
Skills
| Field | Type | Required | Description |
|---|---|---|---|
type | string | Yes | custom または qoder。 |
skill_id | string | Yes | Skill ID。 |
version | string | No | Skill のバージョン。省略した場合は最新バージョンが使用されます。 |
enabled | boolean | No | デフォルトは true。false にすると、コンパイルされたエージェント設定にその Skill が含まれなくなります。 |
Multiagent
multiagent は現在の Template を coordinator として設定し、委任先の Agent を宣言します。
| フィールド | 型 | 必須 | 説明 |
|---|---|---|---|
type | string | はい | coordinator を指定します。 |
agents | array | はい | 委任可能な Agent の一覧。1〜20 件を指定します。 |
multiagent.agents[] では、{"type":"agent","template_id":"tmpl_research"} のような Template 参照、または coordinator 自身を示す {"type":"self"} を使用できます。Template 参照には任意の name も指定できます。
参照する Template は現在の呼び出し元からアクセスできる必要があります。multiagent を使用する場合、tools に agent_toolset_20260401 が必要です。同じ更新リクエストで tools も指定する場合は、置き換え後の配列にこの toolset を残してください。
| リクエスト形式 | 意味 |
|---|---|
| フィールドを省略 | 現在の multiagent 設定を保持します。 |
multiagent: null | multiagent 設定をクリアします。 |
| 空でないオブジェクト | 現在の設定を置き換えます。 |
Example request
Example response
HTTP 200 OK
Response fields
| Field | Type | Description |
|---|---|---|
| Return value | object | 更新された完全な Template オブジェクト。 |
multiagent | object|null | 更新後の Multi-agent 設定。未設定の場合は null。 |
Errors
| HTTP | Type | Trigger |
|---|---|---|
| 400 | invalid_request_error | リクエストボディが不正、またはサポートされていないフィールド値。 |
| 400 | invalid_request_error | browser_toolset_20260714 を使用しているが、正しい X-Qoder-Beta Header がない。 |
| 400 | invalid_request_error | multiagent の構造が不正、agents が 1〜20 件の範囲外、または参照先 Template にアクセスできない。 |
| 401 | authentication_error | PAT または SAT が無効または期限切れ。 |
| 404 | not_found_error | テンプレートまたは参照されたリソースが存在しない。 |
| 409 | conflict_error | テンプレート名が既に存在する。 |
| 401 | authentication_error | authentication_required |
Notes
- アーカイブ済みのテンプレートは更新できません。
- セッションのデフォルト値を更新しても、既存のセッションは変更されません。