Lewati ke konten

Ambil dan perbarui konfigurasi lengkap Agen AI melalui REST API.

Ambil dan perbarui konfigurasi lengkap Agen AI, termasuk kepribadian, gaya percakapan, dan prompt sistem.

Pengaturan perilaku tersedia dalam Identitas > Persona AI di Dasbor. Teks untuk pengunjung tersedia dalam Saluran > Situs Web Anda > Konten teks. Tabel kolom berikut mencantumkan lokasi tepat setiap pengaturan.

Cakupan: read_all

GET https://app.quickchat.ai/v1/api/chatbot_settings

Terminal window
curl https://app.quickchat.ai/v1/api/chatbot_settings \
-H 'Authorization: Bearer <API_TOKEN>'

Respons 200 OK

{
"personality": 0,
"profession": "helpful_assistant",
"creativity_level": 1,
"greeting": "<p>Hello! How can I help you today?</p>",
"greeting2": "",
"header": "Support Assistant",
"header2": "",
"language_chosen": "en",
"reply_length": 1,
"one_word_description": "Support Agent",
"short_description": "A helpful customer support assistant.",
"ai_commands": ["Be polite", "Stay on topic"]
}
KolomDeskripsi
one_word_description
string
Nama Agen AI. Dasbor: Identitas > Persona AI > Nama. API menerima hingga 200 karakter; kolom aplikasi membatasinya hingga 40.
short_description
string
Prompt Utama (prompt sistem). Dasbor: Identitas > Persona AI > Prompt Utama. API menerima hingga 25.000 karakter pada semua paket; editor aplikasi membatasinya sesuai paket, mulai dari 15.000.
ai_commands
array of strings
Pedoman perilaku AI, satu per elemen array. Dasbor: Identitas > Persona AI > Pedoman. Maksimal 250 elemen, 5.000 karakter per elemen, dan total 10.000 karakter.
personality
integer (0–13)
Preset kepribadian AI. Dasbor: Identitas > Persona AI > Kepribadian. Lihat tabel di bawah
profession
string
Profesi/peran AI. Dasbor: Identitas > Persona AI > Peran (maksimal 200 karakter). Lihat tabel di bawah
creativity_level
integer (0–2)
Dasbor: Identitas > Persona AI > Kreativitas. 0 = Rendah, 1 = Normal, 2 = Tinggi
reply_length
integer (0–2)
Dasbor: Identitas > Persona AI > Panjang Balasan. 0 = Singkat, 1 = Normal, 2 = Lebih panjang
greeting
string
Pesan sambutan utama (HTML). Dasbor: Saluran > Situs Web Anda > Konten teks > Pesan sambutan (maksimal 1.000 karakter). Ini kolom yang sama dengan welcome_message dalam Konfigurasi Widget.
greeting2
string
Pesan sambutan kedua (HTML). Tersedia melalui API; tidak ada kolom editnya di Dasbor.
header
string
Teks header chat. Dasbor: Saluran > Situs Web Anda > Konten teks > Teks header (maksimal 200 karakter)
header2
string
Teks header kedua (maksimal 200 karakter). Tersedia melalui API sebagai header2, atau subtitle dalam Konfigurasi Widget; tidak ada kolom editnya di Dasbor.
language_chosen
string
Kode bahasa dipisahkan koma (misalnya "en,es,de"). Dasbor: Identitas > Persona AI > Bahasa (maksimal total 200 karakter; kode setelah batas 30 bahasa diabaikan)

Nilai Kepribadian:

NilaiLabelDeskripsi
0KlasikSeimbang antara profesionalisme dan keramahan (default)
1HumorisNada jenaka dengan permainan kata dan lelucon untuk interaksi menghibur
2FormalFormal dan serius, dengan informasi faktual ringkas untuk kebutuhan bisnis
3RamahPercakapan santai dengan sentuhan pribadi yang mudah didekati
4Ceplas-ceplosPercaya diri dan ceria dengan humor
5CerdasInformasi terperinci dan akurat untuk pemahaman menyeluruh
6EmpatikInteraksi penuh perhatian dan empati terhadap perasaan
7BeraniPendapat dan rekomendasi tegas yang disampaikan dengan percaya diri
9AntusiasInteraksi yang hidup dan penuh energi
10MisteriusJawaban samar dan menarik untuk pengalaman unik
11InspiratifMendorong pemikiran positif dan pencapaian tujuan seperti seorang pelatih
12PetualangMendorong keluar dari zona nyaman dan menjelajahi peluang baru
13EleganPengalaman berkelas untuk merek yang unik dan istimewa

Nilai Peran:

NilaiLabel DasborDeskripsi
helpful_assistantAsisten yang MembantuSerbaguna, untuk berbagai tujuan. Direkomendasikan untuk sebagian besar kebutuhan
customer_support_representativeAgen DukunganEmpatik, memberi solusi bertahap dan bantuan pemecahan masalah
shopping_assistantAsisten BelanjaSecara proaktif menawarkan rekomendasi produk beserta tautan
field_expertPakar BidangKonsultan profesional yang mengajukan pertanyaan klarifikasi dan memberi panduan ahli
interviewerPewawancaraMengajukan pertanyaan alih-alih memberi jawaban. Untuk survei, wawancara, dan umpan balik

Kolom one_word_description, short_description, dan ai_commands juga tersedia melalui endpoint Pengaturan Basis Pengetahuan. Kolom ini digunakan bersama; pembaruan melalui salah satu endpoint mengubah data dasar yang sama.

Cakupan: write_all

PATCH https://app.quickchat.ai/v1/api/chatbot_settings

Isi Permintaan: seluruh kolom opsional. Sertakan hanya kolom yang ingin diperbarui.

ParameterDeskripsi
personality
integer (0–13)
Preset kepribadian AI
profession
string
Profesi/peran AI (maksimal 200 karakter)
creativity_level
integer (0–2)
0 = Rendah, 1 = Normal, 2 = Tinggi
greeting
string
Pesan sambutan utama (HTML, maksimal 1.000 karakter)
greeting2
string
Pesan sambutan kedua
header
string
Teks header chat (maksimal 200 karakter)
header2
string
Teks header kedua (maksimal 200 karakter)
language_chosen
string
Kode bahasa dipisahkan koma (maksimal total 200 karakter; kode setelah batas 30 bahasa diabaikan)
reply_length
integer (0–2)
0 = Singkat, 1 = Normal, 2 = Lebih panjang
one_word_description
string
Nama Agen AI. API maksimal 200 karakter; kolom aplikasi membatasinya hingga 40.
short_description
string
Prompt Utama AI (prompt sistem). API menerima hingga 25.000 karakter pada semua paket; editor aplikasi membatasinya sesuai paket, mulai dari 15.000. Nilai yang terlalu panjang mengembalikan 422.
ai_commands
array of strings
Pedoman AI, satu per elemen array. Maksimal 250 elemen, 5.000 karakter per elemen, dan total 10.000 karakter. Nilai yang terlalu panjang mengembalikan 422.

Setiap elemen array adalah satu pedoman yang disimpan persis seperti dikirim. Tanda baca, termasuk titik koma, tetap dipertahankan. Endpoint ini sebelumnya menghapus ; dari teks sebelum menyimpan, sehingga Anda tidak perlu lagi menghapus atau mengganti titik koma untuk mengatasinya.

Abaikan ai_commands, atau kirim null, agar pedoman tetap seperti semula. Kirim [] untuk mengosongkannya.

Terminal window
curl -X PATCH https://app.quickchat.ai/v1/api/chatbot_settings \
-H 'Authorization: Bearer <API_TOKEN>' \
-H 'Content-Type: application/json' \
-d '{
"greeting": "<p>Welcome! Ask me anything.</p>",
"creativity_level": 2
}'

Respons 200 OK: mengembalikan pengaturan chatbot yang diperbarui (skema sama seperti respons Mengambil Pengaturan Chatbot).