Перейти к содержимому

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

Получайте и обновляйте полную конфигурацию AI-агента, включая личность, стиль общения и системный промпт.

Настройки поведения находятся в Идентичность > Личность AI в панели управления. Тексты для посетителей находятся в Каналы > Ваш сайт > Текстовое содержимое. Таблица ниже указывает точное расположение каждой настройки.

Права: read_all

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

Окно терминала
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
строка
Имя AI-агента. В панели: Идентичность > Личность AI > Название. API принимает до 200 символов; поле приложения ограничено 40.
short_description
строка
Основной промпт (системный промпт). В панели: Идентичность > Личность AI > Основной промпт. API принимает до 25 000 символов на любом тарифе; редактор приложения ограничен лимитом тарифа, начиная с 15 000.
ai_commands
массив строк
Инструкции по поведению AI, по одной на элемент массива. В панели: Идентичность > Личность AI > Инструкции. До 250 элементов, 5 000 символов в каждом и 10 000 суммарно.
personality
целое число (0–13)
Готовый тип личности AI. В панели: Идентичность > Личность AI > Личность. См. таблицу ниже
profession
строка
Профессия или роль AI. В панели: Идентичность > Личность AI > Профессия (до 200 символов). См. таблицу ниже
creativity_level
целое число (0–2)
В панели: Идентичность > Личность AI > Креативность. 0 = Низкое, 1 = Обычная, 2 = Высокое
reply_length
целое число (0–2)
В панели: Идентичность > Личность AI > Длина ответа. 0 = Короткий, 1 = Обычная, 2 = Длиннее
greeting
строка
Основное приветствие (HTML). В панели: Каналы > Ваш сайт > Текстовое содержимое > Приветственное сообщение (до 1 000 символов). То же поле, что welcome_message в настройках виджета.
greeting2
строка
Дополнительное приветствие (HTML). Доступно через API; отдельного поля в панели управления нет.
header
строка
Текст заголовка чата. В панели: Каналы > Ваш сайт > Текстовое содержимое > Текст заголовка (до 200 символов)
header2
строка
Дополнительный текст заголовка (до 200 символов). Доступен через API как header2 или как subtitle в настройках виджета; поля в панели управления нет.
language_chosen
строка
Коды языков через запятую (например, "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 также доступны через endpoint Настройки Базы знаний. Это общие поля: обновление через любой endpoint меняет одни и те же данные.

Права: write_all

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

Тело запроса: все поля необязательные. Включайте только те, которые хотите изменить.

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

Каждый элемент массива является одной инструкцией и сохраняется точно в отправленном виде. Пунктуация, включая точки с запятой, сохраняется. Ранее endpoint удалял ; из текста перед сохранением. Если вы удаляли или заменяли точки с запятой для обхода этой проблемы, теперь это не нужно.

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

Окно терминала
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: возвращает обновлённые настройки чат-бота (схема как в ответе Получения настроек чат-бота).