All Products
Search
Document Center

Seri Qoder CN:Buat templat

Last Updated:Jul 04, 2026

Buat garis dasar templat Forward untuk sesi mendatang.

Header permintaan

Header

Wajib

Deskripsi

Authorization

Ya

Bearer <PAT>

Content-Type

Ya

application/json

Idempotency-Key

Tidak

Kunci idempotensi opsional untuk permintaan yang mengubah status.

Body permintaan

Parameter

Tipe

Wajib

Deskripsi

name

string

Ya

Nama templat. Harus terdiri dari 1–256 karakter dan unik dalam akun.

model

string

Ya

Identifikasi model, seperti ultimate.

environment_id

string

Ya

Lingkungan default yang diterapkan ke sesi yang dibuat dari templat ini.

description

string

Tidak

Deskripsi templat. Maksimal 2.048 karakter.

system

string

Tidak

Prompt sistem. Maksimal 100.000 karakter.

tools

array

Tidak

Konfigurasi tool. Maksimal 128 item.

mcp_servers

array

Tidak

Konfigurasi server MCP. Maksimal 20 item.

skills

array

Tidak

Binding skill. Maksimal 20 item.

multiagent

object

Tidak

Konfigurasi Managed Agents.

vault_ids

array

Tidak

ID vault default yang diterapkan ke sesi.

files

object

Tidak

Sumber daya file default, diindeks berdasarkan ID file.

environment_variables

object|string

Tidak

Variabel lingkungan default untuk sesi.

metadata

object

Tidak

Metadata kustom.

Objek konfigurasi bersarang

Files

files adalah peta yang diindeks berdasarkan ID file. Jangan sertakan file_id, id, atau resource_id dalam setiap entri. Forward secara otomatis menyuntikkan mount_path saat sesi dimulai.

Bidang

Tipe

Wajib

Deskripsi

enabled

boolean

Tidak

Menghilangkan bidang ini setara dengan true. Dalam Identity Config, atur false untuk menonaktifkan file yang diwariskan.

Item tools[]

Setiap entri dalam tools mengambil bentuk berdasarkan nilai type.

Bidang

Tipe

Berlaku untuk

Deskripsi

type

string

Semua

Wajib. Salah satu dari agent_toolset_20260401, mcp_toolset, atau custom.

enabled_tools

array

agent_toolset_20260401

Daftar izin praktis. Array tidak kosong hanya mengaktifkan tool bawaan yang tercantum.

disallowed_tools

array

agent_toolset_20260401

Daftar larangan praktis. Dikompilasi menjadi konfigurasi tool yang dinonaktifkan.

configs

array

agent_toolset_20260401, mcp_toolset

Status pengaktifan per-tool dan kebijakan izin.

mcp_server_name

string

mcp_toolset

Wajib. Harus sesuai dengan salah satu nilai mcp_servers[].name.

name

string

custom

Wajib. Nama tool kustom; tidak boleh bertabrakan dengan nama tool bawaan.

description

string

custom

Wajib. Deskripsi tool kustom yang dapat dibaca manusia.

input_schema

object

custom

Skema JSON wajib. input_schema.type harus berupa object.

Nama tool bawaan mencakup Bash, Read, Write, Edit, Glob, Grep, WebFetch, WebSearch, dan DeliverArtifacts.

Konfigurasi tool

Setiap entri dalam tools[].configs menggunakan struktur berikut.

Bidang

Tipe

Wajib

Deskripsi

name

string

Ya

Nama tool. Gunakan nama tool bawaan untuk toolset bawaan, atau nama tool MCP untuk toolset MCP.

enabled

boolean

Tidak

false menyembunyikan dan menolak tool; true mengaktifkannya secara eksplisit.

permission_policy

object

Tidak

Perilaku izin runtime.

Kebijakan izin

Bidang

Tipe

Wajib

Deskripsi

type

string

Ya

Salah satu dari always_allow, always_ask, atau always_deny.

Server MCP

Bidang

Tipe

Wajib

Deskripsi

type

string

Tidak

Hanya http yang didukung saat ini. Jika dihilangkan, konfigurasi efektif memperlakukan entri sebagai server MCP HTTP.

name

string

Ya

Nama server MCP, unik dalam templat. Dirujuk oleh tools[].mcp_server_name.

url

string

Ya

URL titik akhir MCP HTTP yang dapat dialirkan.

Item skills[]

Bidang

Tipe

Wajib

Deskripsi

type

string

Ya

Salah satu dari custom atau qoder.

skill_id

string

Ya

ID skill.

version

string

Tidak

Versi skill. Menggunakan versi terbaru jika dihilangkan.

enabled

boolean

Tidak

Menghilangkan bidang ini setara dengan true. Atur false untuk mengecualikan skill dari konfigurasi agen yang dikompilasi.

Contoh permintaan

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": {}
  }'

Contoh tanggapan

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

Bidang tanggapan

Bidang

Tipe

Deskripsi

type

string

Selalu template.

id

string

ID templat.

status

string

active atau archived.

environment_id

string

ID lingkungan default yang diterapkan ke sesi.

vault_ids

array

ID vault default.

files

object

Konfigurasi sumber daya file default diindeks berdasarkan ID file.

created_at

string

Stempel waktu pembuatan.

updated_at

string

Stempel waktu pembaruan terakhir.

Kesalahan

HTTP

Tipe

Pemicu

400

invalid_request_error

Body permintaan atau nilai bidang tidak valid.

401

authentication_error

PAT tidak valid atau telah kedaluwarsa.

404

not_found_error

Lingkungan, skill, vault, atau file yang dirujuk tidak ada.

409

conflict_error

Templat dengan nama yang sama sudah ada.

Catatan

  • Jangan sertakan ID templat dalam permintaan pembuatan. Forward akan menghasilkan id untuk Anda.

  • files diindeks berdasarkan ID file. Jangan sertakan file_id, id, atau resource_id dalam setiap entri.

  • Forward secara otomatis menyuntikkan jalur mount file saat sesi dimulai.