Buat garis dasar templat Forward untuk sesi mendatang.
Header permintaan
|
Header |
Wajib |
Deskripsi |
|
|
Ya |
|
|
|
Ya |
|
|
|
Tidak |
Kunci idempotensi opsional untuk permintaan yang mengubah status. |
Body permintaan
|
Parameter |
Tipe |
Wajib |
Deskripsi |
|
|
string |
Ya |
Nama templat. Harus terdiri dari 1–256 karakter dan unik dalam akun. |
|
|
string |
Ya |
Identifikasi model, seperti |
|
|
string |
Ya |
Lingkungan default yang diterapkan ke sesi yang dibuat dari templat ini. |
|
|
string |
Tidak |
Deskripsi templat. Maksimal 2.048 karakter. |
|
|
string |
Tidak |
Prompt sistem. Maksimal 100.000 karakter. |
|
|
array |
Tidak |
Konfigurasi tool. Maksimal 128 item. |
|
|
array |
Tidak |
Konfigurasi server MCP. Maksimal 20 item. |
|
|
array |
Tidak |
Binding skill. Maksimal 20 item. |
|
|
object |
Tidak |
Konfigurasi Managed Agents. |
|
|
array |
Tidak |
ID vault default yang diterapkan ke sesi. |
|
|
object |
Tidak |
Sumber daya file default, diindeks berdasarkan ID file. |
|
|
object|string |
Tidak |
Variabel lingkungan default untuk sesi. |
|
|
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 |
|
|
boolean |
Tidak |
Menghilangkan bidang ini setara dengan |
Item tools[]
Setiap entri dalam tools mengambil bentuk berdasarkan nilai type.
|
Bidang |
Tipe |
Berlaku untuk |
Deskripsi |
|
|
string |
Semua |
Wajib. Salah satu dari |
|
|
array |
|
Daftar izin praktis. Array tidak kosong hanya mengaktifkan tool bawaan yang tercantum. |
|
|
array |
|
Daftar larangan praktis. Dikompilasi menjadi konfigurasi tool yang dinonaktifkan. |
|
|
array |
|
Status pengaktifan per-tool dan kebijakan izin. |
|
|
string |
|
Wajib. Harus sesuai dengan salah satu nilai |
|
|
string |
|
Wajib. Nama tool kustom; tidak boleh bertabrakan dengan nama tool bawaan. |
|
|
string |
|
Wajib. Deskripsi tool kustom yang dapat dibaca manusia. |
|
|
object |
|
Skema JSON wajib. |
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 |
|
|
string |
Ya |
Nama tool. Gunakan nama tool bawaan untuk toolset bawaan, atau nama tool MCP untuk toolset MCP. |
|
|
boolean |
Tidak |
|
|
|
object |
Tidak |
Perilaku izin runtime. |
Kebijakan izin
|
Bidang |
Tipe |
Wajib |
Deskripsi |
|
|
string |
Ya |
Salah satu dari |
Server MCP
|
Bidang |
Tipe |
Wajib |
Deskripsi |
|
|
string |
Tidak |
Hanya |
|
|
string |
Ya |
Nama server MCP, unik dalam templat. Dirujuk oleh |
|
|
string |
Ya |
URL titik akhir MCP HTTP yang dapat dialirkan. |
Item skills[]
|
Bidang |
Tipe |
Wajib |
Deskripsi |
|
|
string |
Ya |
Salah satu dari |
|
|
string |
Ya |
ID skill. |
|
|
string |
Tidak |
Versi skill. Menggunakan versi terbaru jika dihilangkan. |
|
|
boolean |
Tidak |
Menghilangkan bidang ini setara dengan |
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 |
|
|
string |
Selalu |
|
|
string |
ID templat. |
|
|
string |
|
|
|
string |
ID lingkungan default yang diterapkan ke sesi. |
|
|
array |
ID vault default. |
|
|
object |
Konfigurasi sumber daya file default diindeks berdasarkan ID file. |
|
|
string |
Stempel waktu pembuatan. |
|
|
string |
Stempel waktu pembaruan terakhir. |
Kesalahan
|
HTTP |
Tipe |
Pemicu |
|
400 |
|
Body permintaan atau nilai bidang tidak valid. |
|
401 |
|
PAT tidak valid atau telah kedaluwarsa. |
|
404 |
|
Lingkungan, skill, vault, atau file yang dirujuk tidak ada. |
|
409 |
|
Templat dengan nama yang sama sudah ada. |
Catatan
-
Jangan sertakan ID templat dalam permintaan pembuatan. Forward akan menghasilkan
iduntuk Anda. -
filesdiindeks berdasarkan ID file. Jangan sertakanfile_id,id, atauresource_iddalam setiap entri. -
Forward secara otomatis menyuntikkan jalur mount file saat sesi dimulai.