Buat sesi Forward berdasarkan suatu Identity dan Template.
Header permintaan
|
Header |
Wajib |
Deskripsi |
|
|
Ya |
|
|
|
Ya |
|
|
|
Tidak |
Kunci idempotensi opsional untuk permintaan yang tidak aman. |
Badan permintaan
|
Parameter |
Tipe |
Wajib |
Deskripsi |
|
|
string |
Ya |
Penerusan ID Identitas. |
|
|
string |
Ya |
ID Forward Template. |
|
|
string |
Tidak |
Judul sesi. |
|
|
boolean |
Tidak |
Mengaktifkan event streaming inkremental asisten. Nilai default-nya adalah |
|
|
object |
Tidak |
Metadata kustom. |
|
|
object |
Tidak |
Penggantian konfigurasi per-sesi. Hanya bidang yang ada dalam daftar izin yang diterima. |
|
|
object |
Tidak |
Variabel lingkungan sesi dalam bentuk pasangan kunci-nilai. |
|
|
array |
Tidak |
Sumber daya tingkat sesi, saat ini berupa file mounts. |
|
|
string |
Ya jika |
Tipe sumber daya. Saat ini hanya |
|
|
string |
Ya jika |
ID file dari Files API. |
|
|
string |
Tidak |
Jalur mount di dalam kontainer agen. Jika diabaikan, Forward akan menentukan jalurnya berdasarkan nama file. |
Contoh permintaan
curl -s -X POST 'https://api.qoder.com.cn/api/v1/forward/sessions' \
-H "Authorization: Bearer $QODER_PAT" \
-H "Content-Type: application/json" \
-d '{
"identity_id": "idn_xxx",
"template_id": "tmpl_support",
"title": "Customer support session",
"incremental_streaming_enabled": true,
"metadata": {
"source": "web",
"biz_id": "ticket_123"
},
"config": {
"environment_variables": {
"API_KEY": "sk-xxx",
"REGION": "cn-hangzhou"
}
},
"resources": [
{
"type": "file",
"file_id": "file_019e6a18dc09abcd",
"mount_path": "/data/input.py"
}
]
}'
Contoh tanggapan
HTTP 200 OK
{
"id": "sess_xxx",
"type": "session",
"identity_id": "idn_xxx",
"template": {
"id": "tmpl_support",
"type": "template",
"name": "Support assistant",
"model": "ultimate",
"version": 3
},
"source_type": "api",
"status": "idle",
"title": "Customer support session",
"incremental_streaming_enabled": true,
"metadata": {
"source": "web",
"biz_id": "ticket_123"
},
"config": {
"environment_variables": {
"API_KEY": "sk-xxx"
}
},
"stats": {
"active_seconds": 0,
"duration_seconds": 0
},
"archived_at": null,
"created_at": "2026-06-22T10:00:00Z",
"updated_at": "2026-06-22T10:00:00Z"
}
Bidang tanggapan
|
Bidang |
Tipe |
Deskripsi |
|
|
string |
ID sesi. |
|
|
string |
Selalu |
|
|
string |
ID Forward Identity. |
|
|
object |
Rangkuman template. |
|
|
string |
Sumber sesi. Pembuatan langsung melalui API menggunakan |
|
|
string |
|
|
|
boolean |
Menunjukkan apakah streaming inkremental diaktifkan untuk sesi ini. |
|
|
string|null |
Timestamp arsip. |
|
|
string |
Timestamp pembuatan. |
|
|
string |
Timestamp pembaruan. |
Kesalahan
|
HTTP |
Tipe |
Kode |
Pemicu |
|
400 |
|
|
Badan permintaan tidak valid. |
|
403 |
|
|
Identity tidak dapat menggunakan Template tersebut. |
|
404 |
|
|
Identity tidak ada atau telah dihapus. |
|
404 |
|
|
Template tidak ada. |
|
409 |
|
|
Identity dinonaktifkan. |
|
422 |
|
|
Konfigurasi waktu proses efektif tidak valid. |
|
401 |
|
|
PAT tidak valid atau telah kedaluwarsa. |
Catatan
-
source_typeditetapkan oleh Forward dan tidak diterima dalam permintaan pembuatan. -
incremental_streaming_enableddisimpan pada Sesi dan tidak dapat diubah setelahnya. -
File yang diunggah harus sudah tersedia di Files API sebelum dimasukkan ke dalam
resources.