すべてのプロダクト
Search
ドキュメントセンター

Qoder CN シリーズ:テンプレートの作成

最終更新日:Jul 04, 2026

将来のセッションに備えて、Forward のテンプレートベースラインを作成します。

リクエストヘッダー

ヘッダー

必須

説明

Authorization

はい

Bearer <PAT>

Content-Type

はい

application/json

Idempotency-Key

いいえ

状態を変更するリクエスト用の任意のべき等キーです。

リクエストボディ

パラメーター

タイプ

必須

説明

name

string

はい

テンプレート名です。1~256 文字で、アカウント内で一意である必要があります。

model

string

はい

ultimate などのモデル識別子です。

environment_id

string

はい

このテンプレートから作成するセッションに適用される、デフォルトの環境です。

description

string

いいえ

テンプレートの説明です。最大 2,048 文字です。

system

string

いいえ

システムプロンプトです。最大 100,000 文字です。

tools

array

いいえ

ツール構成です。最大 128 項目です。

mcp_servers

array

いいえ

MCP サーバー構成です。最大 20 項目です。

skills

array

いいえ

スキルバインディングです。最大 20 項目です。

multiagent

object

いいえ

Managed Agents 構成です。

vault_ids

array

いいえ

セッション用のデフォルトのボールト ID です。

files

object

いいえ

ファイル ID をキーとするデフォルトのファイルリソースです。

environment_variables

object|string

いいえ

セッション用のデフォルトの環境変数です。

metadata

object

いいえ

カスタムメタデータです。

ネストされた構成オブジェクト

Files

files は、ファイル ID をキーとするマップです。 各エントリ内に file_idid、または resource_id を含めないでください。 セッションが開始されると、Forward は mount_path を自動的に挿入します。

フィールド

タイプ

必須

説明

enabled

boolean

いいえ

フィールドを省略すると true と同等になります。Identity Config では、継承されたファイルを無効にするには false を設定します。

tools[] の項目

tools の各エントリは、type に基づいてシェイプを選択します。

フィールド

タイプ

適用先

説明

type

string

すべて

必須。agent_toolset_20260401mcp_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

カスタム

必須です。カスタムツール名です。組み込みツール名と競合してはなりません。

description

string

カスタム

必須です。人が読んでわかる、カスタムツールの説明です。

input_schema

object

カスタム

JSON スキーマは必須です。input_schema.typeobject である必要があります。

組み込みツール名には BashReadWriteEditGlobGrepWebFetchWebSearch、および DeliverArtifacts が含まれます。

ツール設定

tools[].configs の各エントリは、次の形式を使用します。

フィールド

タイプ

必須

説明

name

string

はい

ツール名です。組み込みツールセットの場合は組み込みツール名を使用し、MCP ツールセットの場合は MCP ツール名を使用します。

enabled

boolean

いいえ

false はツールを非表示にして無効化し、true は明示的に有効化します。

permission_policy

object

いいえ

実行時の権限の動作です。

権限ポリシー

フィールド

タイプ

必須

説明

type

string

はい

always_allowalways_ask、またはalways_deny のいずれか。

MCP サーバー

フィールド

タイプ

必須

説明

type

string

いいえ

現在、http のみがサポートされています。省略された場合、有効な設定ではエントリが HTTP MCP サーバーとして扱われます。

name

string

はい

MCP サーバー名。テンプレート内で一意です。 tools[].mcp_server_name から参照されます。

url

string

はい

ストリーミング可能な HTTP MCP エンドポイント URL です。

skills[] の項目

フィールド

タイプ

必須

説明

type

string

はい

custom または qoder のいずれか。

skill_id

string

はい

スキル ID です。

version

string

いいえ

スキルバージョンです。省略した場合は最新バージョンが使用されます。

enabled

boolean

いいえ

フィールドを省略した場合は、true と同等です。スキルをコンパイル済みのエージェント設定から除外するには、false に設定します。

リクエスト例

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"
}

レスポンスフィールド

フィールド

タイプ

説明

type

string

常に template です。

id

string

テンプレート ID です。

status

string

active または archived

environment_id

string

セッションに適用するデフォルトの環境 ID です。

vault_ids

array

デフォルトのボールト ID です。

files

object

ファイル ID をキーとするデフォルトのファイルリソース構成です。

created_at

string

作成タイムスタンプです。

updated_at

string

最終更新タイムスタンプです。

エラー

HTTP

タイプ

トリガー

400

invalid_request_error

リクエストボディまたはフィールド値が無効です。

401

authentication_error

PAT が無効であるか、有効期限が切れています。

404

not_found_error

参照先の環境、スキル、ボールト、またはファイルが存在しません。

409

conflict_error

同じ名前のテンプレートがすでに存在します。

注意事項

  • 作成リクエストでテンプレート ID を送信しないでください。Forward が id を生成します。

  • files はファイル ID をキーとしています。各エントリに file_idid、または resource_id を含めないでください。

  • Forward は、セッション開始時にファイルのマウントパスを自動的に挿入します。