Pemeriksaan contoh opsional
Section titled “Pemeriksaan contoh opsional”-
Pratinjau kecocokan JSONPath. Periksa jalur root, bidang, indeks array, dan wildcard terhadap JSON yang diberikan. Pemeriksaan ini tidak menjalankan Tindakan atau menyimpan memori percakapan.
-
Periksa contoh koneksi MCP. Inisialisasi dan tampilkan daftar tool hanya pada endpoint dokumentasi Cloudflare atau Microsoft Learn. Tidak ada proses masuk atau eksekusi tool.
Di browser yang kompatibel, pemeriksaan ini juga tersedia sebagai tool situs. Tautannya membuka formulir standar.
Tindakan AI
Section titled “Tindakan AI”Tindakan AI memperluas kemampuan Agen AI Anda melampaui menjawab pertanyaan dari Basis Pengetahuan. Anda dapat menentukan perilaku yang dipicu, yaitu hal yang harus dilakukan AI ketika mendeteksi situasi tertentu dalam percakapan.
Kegunaan Tindakan AI:
- Tindakan Permintaan HTTP: Memanggil API eksternal ketika dipicu. Misalnya, memeriksa status pesanan di backend Anda, membuat tiket dukungan, atau mencari informasi akun, semuanya selama percakapan berlangsung.
- Tindakan MCP: Menghubungkan server Model Context Protocol untuk integrasi tool lanjutan (misalnya pencarian produk Shopify atau kueri basis data khusus).
Contoh penggunaan umum:
- Mencari informasi realtime (status pesanan, detail akun, persediaan) dari sistem backend Anda selama percakapan
- Membuat tiket, memperbarui data CRM, atau memicu alur kerja dalam sistem eksternal berdasarkan konteks percakapan
- Memberikan rekomendasi yang dipersonalisasi dengan mencari katalog produk Anda
Setiap tindakan memiliki name, description (untuk Tindakan Permintaan HTTP, deskripsi memberi tahu AI kapan harus memicunya), dan konfigurasi khusus jenisnya. Tindakan dapat diaktifkan/dinonaktifkan satu per satu melalui API. Tindakan dibuat dan dikonfigurasi sepenuhnya di Dashboard Quickchat. API menyediakan operasi untuk menampilkan daftar, memperbarui (mengaktifkan/menonaktifkan), dan menghapus, serta endpoint khusus untuk membuat dan mengonfigurasi Tindakan MCP.
Tampilkan Semua Tindakan AI
Section titled “Tampilkan Semua Tindakan AI”GET https://app.quickchat.ai/v1/api/ai_actions
curl https://app.quickchat.ai/v1/api/ai_actions \ -H 'Authorization: Bearer <API_TOKEN>'import requests
response = requests.get( url="https://app.quickchat.ai/v1/api/ai_actions", headers={"Authorization": "Bearer <API_TOKEN>"},)data = response.json()Respons 200 OK
[ { "id": 1, "name": "Check Order Status", "description": "Look up order status when customer asks about their order.", "is_active": true, "type": "http_request", "icon": null, "icon_color": null, "is_valid": true }]| Bidang | Deskripsi |
|---|---|
id integer | Pengenal Tindakan AI |
name string | Nama tampilan |
description string | Kapan tindakan dipicu |
is_active boolean | Apakah tindakan diaktifkan |
type string | "http_request", "remote_mcp", "shopify_remote_mcp", atau "knowledge_base" |
icon string atau null | Pengenal ikon |
icon_color string atau null | Warna ikon |
is_valid boolean | Apakah konfigurasi sudah benar |
Perbarui Tindakan AI
Section titled “Perbarui Tindakan AI”PATCH https://app.quickchat.ai/v1/api/ai_actions/{action_id}
Isi Permintaan
| Parameter | Deskripsi |
|---|---|
is_active boolean | Mengaktifkan/menonaktifkan tindakan |
icon string | Pengenal ikon (maksimal 200 karakter) |
icon_color string | Warna ikon (maksimal 50 karakter) |
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/1 \ -H 'Authorization: Bearer <API_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{"is_active": false}'import requests
response = requests.patch( url="https://app.quickchat.ai/v1/api/ai_actions/1", headers={"Authorization": "Bearer <API_TOKEN>"}, json={"is_active": False},)data = response.json()Respons 200 OK. Mengembalikan cuplikan Tindakan AI yang diperbarui.
Hapus Tindakan AI
Section titled “Hapus Tindakan AI”DELETE https://app.quickchat.ai/v1/api/ai_actions/{action_id}
curl -X DELETE https://app.quickchat.ai/v1/api/ai_actions/1 \ -H 'Authorization: Bearer <API_TOKEN>'import requests
response = requests.delete( url="https://app.quickchat.ai/v1/api/ai_actions/1", headers={"Authorization": "Bearer <API_TOKEN>"},)Respons 200 OK (isi kosong)
Buat Tindakan MCP
Section titled “Buat Tindakan MCP”POST https://app.quickchat.ai/v1/api/ai_actions/remote_mcp
Menghubungkan server MCP jarak jauh ke Agen AI Anda sebagai Tindakan MCP. Memerlukan token API dengan cakupan write_all (token API memerlukan paket Business atau lebih tinggi).
Isi Permintaan
| Parameter | Deskripsi |
|---|---|
remote_mcp_url string, wajib | URL server MCP. Harus menggunakan https://; URL yang mengarah ke alamat jaringan privat atau internal ditolak |
headers array, wajib | Header koneksi yang dikirim ke server, misalnya token Authorization statis. Setiap entri berupa {"id", "name", "value"}. Pilih string unik apa pun sebagai id. Kirim [] jika server tidak memerlukannya |
allowed_tools array, wajib | Sakelar per tool, masing-masing berupa {"name", "is_active"}. Kirim [] agar ketersediaan tool ditentukan oleh default_tool_is_active |
name string | Nama tampilan dalam daftar Tindakan (maksimal 100 karakter). Secara default berupa label yang diambil dari host server |
description string | Deskripsi dalam daftar Tindakan (maksimal 2500 karakter) |
icon string | Pengenal ikon (maksimal 200 karakter) |
icon_color string | Warna ikon (maksimal 50 karakter) |
name dan description adalah label untuk operator: keduanya mengidentifikasi tindakan di dashboard, dan AI tidak pernah membacanya. AI menggunakan deskripsi tool yang diterbitkan oleh server MCP itu sendiri.
curl -X POST https://app.quickchat.ai/v1/api/ai_actions/remote_mcp \ -H 'Authorization: Bearer <API_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "remote_mcp_url": "https://mcp.example.com/mcp", "headers": [ {"id": "h-1", "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"} ], "allowed_tools": [], "name": "Example MCP" }'import requests
response = requests.post( url="https://app.quickchat.ai/v1/api/ai_actions/remote_mcp", headers={"Authorization": "Bearer <API_TOKEN>"}, json={ "remote_mcp_url": "https://mcp.example.com/mcp", "headers": [ {"id": "h-1", "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"} ], "allowed_tools": [], "name": "Example MCP", },)data = response.json()Respons 201 Created
{ "id": 2, "name": "Example MCP", "description": "Connected MCP server", "is_active": false, "type": "remote_mcp", "icon": "FaMixcloud", "icon_color": "#EF4444", "is_valid": true, "validation_issues": [], "remote_mcp_url": "https://mcp.example.com/mcp", "remote_mcp_auth_token": "", "default_tool_is_active": true, "allowed_tools": [], "headers": [ {"id": 10, "name": "Authorization", "value": "Bearer <SERVER_TOKEN>"} ], "oauth": null, "recommended_tools": []}| Bidang | Deskripsi |
|---|---|
remote_mcp_url string | URL server MCP yang terhubung |
default_tool_is_active boolean | Apakah tool yang tidak tercantum dalam allowed_tools boleh digunakan |
allowed_tools array | Sakelar per tool, {"name", "is_active"} |
headers array | Header koneksi yang disimpan |
remote_mcp_auth_token string atau null | Bidang token statis lama. Tidak dapat diatur melalui API ini; berikan kredensial melalui headers |
oauth object atau null | Status otorisasi server yang terhubung melalui proses masuk OAuth (null jika tidak) |
recommended_tools array | Nama tool yang direkomendasikan Quickchat untuk server dengan profil terkurasi (hanya baca) |
validation_issues array | Nama pemeriksaan konfigurasi yang gagal; kosong ketika is_valid bernilai true |
Bidang lainnya sama dengan Tampilkan Semua Tindakan AI.
Tindakan dibuat dengan is_active: false. Untuk server tanpa profil Quickchat terkurasi, nilai awalnya juga default_tool_is_active: true, sehingga setiap tool yang ditemukan saat membalas diizinkan sampai Anda membatasinya. Untuk mengaktifkan tindakan, gunakan endpoint Perbarui Tindakan AI di atas: PATCH /v1/api/ai_actions/{action_id} dengan {"is_active": true}.
Dapatkan Konfigurasi Tindakan MCP
Section titled “Dapatkan Konfigurasi Tindakan MCP”GET https://app.quickchat.ai/v1/api/ai_actions/{action_id}/remote_mcp
curl https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \ -H 'Authorization: Bearer <API_TOKEN>'import requests
response = requests.get( url="https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp", headers={"Authorization": "Bearer <API_TOKEN>"},)data = response.json()Respons 200 OK. Mengembalikan konfigurasi khusus MCP dengan bentuk yang sama seperti respons pembuatan di atas.
Perbarui Konfigurasi Tindakan MCP
Section titled “Perbarui Konfigurasi Tindakan MCP”PATCH https://app.quickchat.ai/v1/api/ai_actions/{action_id}/remote_mcp
Semua bidang bersifat opsional; hanya bidang yang Anda kirim yang berubah.
Isi Permintaan
| Parameter | Deskripsi |
|---|---|
remote_mcp_url string | URL server baru (divalidasi seperti saat pembuatan). Mengubah URL server yang terhubung dengan OAuth menghapus otorisasi tersimpan dan menonaktifkan tindakan |
headers array | Mengganti header koneksi |
allowed_tools array | Mengganti sakelar per tool, masing-masing berupa {"name", "is_active"} |
default_tool_is_active boolean | Apakah tool yang tidak tercantum dalam allowed_tools boleh digunakan |
name string | Nama tampilan (maksimal 100 karakter) |
description string | Deskripsi dalam daftar Tindakan (maksimal 2500 karakter) |
curl -X PATCH https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp \ -H 'Authorization: Bearer <API_TOKEN>' \ -H 'Content-Type: application/json' \ -d '{ "allowed_tools": [ {"name": "search_docs", "is_active": true}, {"name": "delete_page", "is_active": false} ], "default_tool_is_active": false }'import requests
response = requests.patch( url="https://app.quickchat.ai/v1/api/ai_actions/2/remote_mcp", headers={"Authorization": "Bearer <API_TOKEN>"}, json={ "allowed_tools": [ {"name": "search_docs", "is_active": True}, {"name": "delete_page", "is_active": False}, ], "default_tool_is_active": False, },)data = response.json()Respons 200 OK. Mengembalikan Tindakan MCP yang diperbarui, dengan bentuk yang sama seperti respons pembuatan.
Pengujian koneksi dan penemuan tool, yaitu pemeriksaan Hubungkan di dashboard, tidak tersedia melalui API publik. Dashboard menjalankan pemeriksaan tersebut secara otomatis saat Anda menghubungkan atau menghubungkan ulang server. Server yang dilindungi OAuth harus menyelesaikan otorisasinya di dashboard; bidang oauth dalam respons di atas melaporkan status tersebut.