Перейти до вмісту

Отримуйте й оновлюйте повну конфігурацію AI-агента через REST API.

Отримуйте й оновлюйте повну конфігурацію AI-агента, зокрема особистість, стиль розмови та системний промпт.

Налаштування поведінки розташовані в Ідентичність > Особистість AI у панелі керування. Тексти для відвідувачів налаштовуються в Канали > Ваш сайт > Текстовий вміст. У таблиці нижче наведено точне розташування кожного параметра.

Отримання налаштувань чатбота

Section titled “Отримання налаштувань чатбота”
Область доступу: 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>'

Відповідь 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"]
}
ПолеОпис
one_word_description
string
Назва AI-агента. Панель керування: Ідентичність > Особистість AI > Назва. API приймає до 200 символів; поле в застосунку обмежене 40 символами.
short_description
string
Основний промпт (системний промпт). Панель керування: Ідентичність > Особистість AI > Основний промпт. API приймає до 25 000 символів на всіх тарифах; редактор у застосунку обмежує довжину відповідно до тарифу, починаючи з 15 000.
ai_commands
array of strings
Інструкції щодо поведінки AI, по одній на елемент масиву. Панель керування: Ідентичність > Особистість AI > Інструкції. До 250 елементів, 5 000 символів на елемент і 10 000 символів загалом.
personality
integer (0–13)
Стиль особистості AI. Панель керування: Ідентичність > Особистість AI > Особистість. Див. таблицю нижче
profession
string
Професія/роль AI. Панель керування: Ідентичність > Особистість AI > Професія (до 200 символів). Див. таблицю нижче
creativity_level
integer (0–2)
Панель керування: Ідентичність > Особистість AI > Креативність. 0 = Низька, 1 = Звичайна, 2 = Висока
reply_length
integer (0–2)
Панель керування: Ідентичність > Особистість AI > Довжина відповіді. 0 = Коротка, 1 = Звичайна, 2 = Довша
greeting
string
Основне привітальне повідомлення (HTML). Панель керування: Канали > Ваш сайт > Текстовий вміст > Привітальне повідомлення (до 1 000 символів). Це те саме поле, що й welcome_message у конфігурації віджета.
greeting2
string
Додаткове привітальне повідомлення (HTML). Доступне через API; поля редактора в панелі керування немає.
header
string
Текст заголовка чату. Панель керування: Канали > Ваш сайт > Текстовий вміст > Текст заголовка (до 200 символів)
header2
string
Додатковий текст заголовка (до 200 символів). Доступний через API як header2 або subtitle у конфігурації віджета; поля редактора в панелі керування немає.
language_chosen
string
Коди мов, розділені комами (наприклад, "en,es,de"). Панель керування: Ідентичність > Особистість AI > Мови (до 200 символів загалом; коди після ліміту в 30 мов відкидаються)

Значення особистості:

ЗначенняНазваОпис
0КласичнийЗбалансований стиль, що поєднує професійність і доброзичливість (за замовчуванням)
1Із гуморомДотепний тон із каламбурами й жартами для веселого спілкування
2ОфіційнийФормальний і серйозний стиль, стисла фактична інформація для ділових ситуацій
3ПривітнийНевимушені розмови з особистим і дружнім підходом
4ЗухвалийУпевнений і грайливий стиль із гумором
5ІнтелектуальнийДокладна й точна інформація для всебічного розуміння
6ЕмпатичнийТурботливе й співчутливе спілкування з увагою до почуттів
7СміливийУпевнене висловлення чітких думок і рекомендацій
9ЗахопленийЖвава й енергійна взаємодія
10ЗагадковийТаємничі й інтригуючі відповіді для незвичного досвіду
11НатхненнийЗаохочує позитивне мислення й досягнення цілей, як тренер
12Схильний до пригодЗаохочує виходити із зони комфорту й відкривати нові можливості
13ЕлегантнийВишукане спілкування для унікальних і витончених брендів

Значення професії:

ЗначенняНазва в панелі керуванняОпис
helpful_assistantКорисний помічникУніверсальний і багатоцільовий. Рекомендовано для більшості сценаріїв
customer_support_representativeАгент підтримкиЕмпатичний, надає покрокові рішення й допомагає усувати неполадки
shopping_assistantПомічник із покупокПроактивно рекомендує товари з посиланнями
field_expertПрофільний експертПрофесійний консультант, ставить уточнювальні запитання й надає експертні поради
interviewerІнтерв’юерСтавить запитання замість відповідей. Для опитувань, інтерв’ю та відгуків

Поля one_word_description, short_description і ai_commands також доступні через ендпоїнт Налаштування Бази знань. Це спільні поля: оновлення через будь-який із цих ендпоїнтів змінює ті самі дані.

Оновлення налаштувань чатбота

Section titled “Оновлення налаштувань чатбота”
Область доступу: write_all

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

Тіло запиту: усі поля необов’язкові. Додавайте лише поля, які хочете оновити.

ПараметрОпис
personality
integer (0–13)
Стиль особистості AI
profession
string
Професія/роль AI (до 200 символів)
creativity_level
integer (0–2)
0 = Низька, 1 = Звичайна, 2 = Висока
greeting
string
Основне привітальне повідомлення (HTML, до 1 000 символів)
greeting2
string
Додаткове привітальне повідомлення
header
string
Текст заголовка чату (до 200 символів)
header2
string
Додатковий текст заголовка (до 200 символів)
language_chosen
string
Коди мов, розділені комами (до 200 символів загалом; коди після ліміту в 30 мов відкидаються)
reply_length
integer (0–2)
0 = Коротка, 1 = Звичайна, 2 = Довша
one_word_description
string
Назва AI-агента. API: до 200 символів; поле в застосунку обмежене 40 символами.
short_description
string
Основний промпт AI (системний промпт). API приймає до 25 000 символів на всіх тарифах; редактор у застосунку обмежує довжину відповідно до тарифу, починаючи з 15 000. Перевищення повертає 422.
ai_commands
array of strings
Інструкції AI, по одній на елемент масиву. До 250 елементів, 5 000 символів на елемент і 10 000 символів загалом. Перевищення повертає 422.

Кожен елемент масиву є окремою інструкцією й зберігається саме так, як ви його надіслали. Пунктуація, зокрема крапки з комою, зберігається. Раніше цей ендпоїнт видаляв ; перед збереженням, тож якщо ви прибирали чи замінювали крапки з комою для обходу цієї поведінки, більше цього робити не потрібно.

Не передавайте ai_commands або надішліть null, щоб залишити інструкції без змін. Надішліть [], щоб очистити їх.

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

Відповідь 200 OK: повертає оновлені налаштування чатбота (та сама схема, що у відповіді Отримання налаштувань чатбота).