将来のセッションに備えて、Forward のテンプレートベースラインを作成します。
リクエストヘッダー
|
ヘッダー |
必須 |
説明 |
|
|
はい |
|
|
|
はい |
|
|
|
いいえ |
状態を変更するリクエスト用の任意のべき等キーです。 |
リクエストボディ
|
パラメーター |
タイプ |
必須 |
説明 |
|
|
string |
はい |
テンプレート名です。1~256 文字で、アカウント内で一意である必要があります。 |
|
|
string |
はい |
|
|
|
string |
はい |
このテンプレートから作成するセッションに適用される、デフォルトの環境です。 |
|
|
string |
いいえ |
テンプレートの説明です。最大 2,048 文字です。 |
|
|
string |
いいえ |
システムプロンプトです。最大 100,000 文字です。 |
|
|
array |
いいえ |
ツール構成です。最大 128 項目です。 |
|
|
array |
いいえ |
MCP サーバー構成です。最大 20 項目です。 |
|
|
array |
いいえ |
スキルバインディングです。最大 20 項目です。 |
|
|
object |
いいえ |
Managed Agents 構成です。 |
|
|
array |
いいえ |
セッション用のデフォルトのボールト ID です。 |
|
|
object |
いいえ |
ファイル ID をキーとするデフォルトのファイルリソースです。 |
|
|
object|string |
いいえ |
セッション用のデフォルトの環境変数です。 |
|
|
object |
いいえ |
カスタムメタデータです。 |
ネストされた構成オブジェクト
Files
files は、ファイル ID をキーとするマップです。 各エントリ内に file_id、id、または resource_id を含めないでください。 セッションが開始されると、Forward は mount_path を自動的に挿入します。
|
フィールド |
タイプ |
必須 |
説明 |
|
|
boolean |
いいえ |
フィールドを省略すると |
tools[] の項目
tools の各エントリは、type に基づいてシェイプを選択します。
|
フィールド |
タイプ |
適用先 |
説明 |
|
|
string |
すべて |
必須。 |
|
|
array |
|
便利な許可リストです。空でない配列を指定すると、一覧に含まれる組み込みツールのみが有効になります。 |
|
|
array |
|
便利な拒否リストです。無効化されたツール構成としてコンパイルされます。 |
|
|
array |
|
ツールごとの有効状態と権限ポリシーです。 |
|
|
string |
|
必須。 |
|
|
string |
|
必須です。カスタムツール名です。組み込みツール名と競合してはなりません。 |
|
|
string |
|
必須です。人が読んでわかる、カスタムツールの説明です。 |
|
|
object |
|
JSON スキーマは必須です。 |
組み込みツール名には Bash、Read、Write、Edit、Glob、Grep、WebFetch、WebSearch、および DeliverArtifacts が含まれます。
ツール設定
tools[].configs の各エントリは、次の形式を使用します。
|
フィールド |
タイプ |
必須 |
説明 |
|
|
string |
はい |
ツール名です。組み込みツールセットの場合は組み込みツール名を使用し、MCP ツールセットの場合は MCP ツール名を使用します。 |
|
|
boolean |
いいえ |
|
|
|
object |
いいえ |
実行時の権限の動作です。 |
権限ポリシー
|
フィールド |
タイプ |
必須 |
説明 |
|
|
string |
はい |
|
MCP サーバー
|
フィールド |
タイプ |
必須 |
説明 |
|
|
string |
いいえ |
現在、 |
|
|
string |
はい |
MCP サーバー名。テンプレート内で一意です。 |
|
|
string |
はい |
ストリーミング可能な HTTP MCP エンドポイント URL です。 |
skills[] の項目
|
フィールド |
タイプ |
必須 |
説明 |
|
|
string |
はい |
|
|
|
string |
はい |
スキル ID です。 |
|
|
string |
いいえ |
スキルバージョンです。省略した場合は最新バージョンが使用されます。 |
|
|
boolean |
いいえ |
フィールドを省略した場合は、 |
リクエスト例
curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/templates' \
-H "Authorization: Bearer $QODER_PAT" \
-H "Content-Type: application/json" \
-d '{
"name": "Support assistant",
"description": "Handles pre-sales and after-sales support",
"model": "ultimate",
"system": "You are a helpful support assistant.",
"tools": [
{
"type": "agent_toolset_20260401",
"configs": [
{ "name": "Read", "enabled": true },
{ "name": "Grep", "enabled": true },
{ "name": "WebSearch", "enabled": true }
]
}
],
"mcp_servers": [],
"skills": [
{
"type": "custom",
"skill_id": "skill_customer_reply",
"version": "1",
"enabled": true
}
],
"environment_id": "env_support",
"vault_ids": ["vault_crm"],
"files": {
"file_019eXXXX": { "enabled": true }
},
"environment_variables": {
"BASE_MODE": "support"
},
"metadata": {}
}'
レスポンス例
HTTP 201 Created
{
"type": "template",
"id": "tmpl_support",
"name": "Support assistant",
"description": "Handles pre-sales and after-sales support",
"status": "active",
"model": "ultimate",
"system": "You are a helpful support assistant.",
"tools": [
{
"type": "agent_toolset_20260401",
"configs": [
{ "name": "Read", "enabled": true },
{ "name": "Grep", "enabled": true },
{ "name": "WebSearch", "enabled": true }
]
}
],
"mcp_servers": [],
"skills": [
{
"type": "custom",
"skill_id": "skill_customer_reply",
"version": "1",
"enabled": true
}
],
"multiagent": null,
"environment_id": "env_support",
"vault_ids": ["vault_crm"],
"files": {
"file_019eXXXX": { "enabled": true }
},
"environment_variables": {
"BASE_MODE": "support"
},
"metadata": {},
"created_at": "2026-06-18T10:00:00Z",
"updated_at": "2026-06-18T10:00:00Z"
}
レスポンスフィールド
|
フィールド |
タイプ |
説明 |
|
|
string |
常に |
|
|
string |
テンプレート ID です。 |
|
|
string |
|
|
|
string |
セッションに適用するデフォルトの環境 ID です。 |
|
|
array |
デフォルトのボールト ID です。 |
|
|
object |
ファイル ID をキーとするデフォルトのファイルリソース構成です。 |
|
|
string |
作成タイムスタンプです。 |
|
|
string |
最終更新タイムスタンプです。 |
エラー
|
HTTP |
タイプ |
トリガー |
|
400 |
|
リクエストボディまたはフィールド値が無効です。 |
|
401 |
|
PAT が無効であるか、有効期限が切れています。 |
|
404 |
|
参照先の環境、スキル、ボールト、またはファイルが存在しません。 |
|
409 |
|
同じ名前のテンプレートがすでに存在します。 |
注意事項
-
作成リクエストでテンプレート ID を送信しないでください。Forward が
idを生成します。 -
filesはファイル ID をキーとしています。各エントリにfile_id、id、またはresource_idを含めないでください。 -
Forward は、セッション開始時にファイルのマウントパスを自動的に挿入します。