Быстрый старт с API
Подготовьте авторизацию. Для ответов бота нужны активный аккаунт, доступные кредиты и настроенное подключение к провайдеру модели.
1. Получить список моделей
GET /api/v1/bots/models/all
URL
https://app.helpfy.ai/api/v1/bots/models/all
Заголовки
| Заголовок | Значение |
|---|---|
Authorization | Basic <base64(email:api_key)> |
Accept | application/json |
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| — | — | Нет | Параметры не требуются. |
Пример запроса
curl --request GET "https://app.helpfy.ai/api/v1/bots/models/all" \
--user "user@example.com:api_key" \
--header 'Accept: application/json'
Ответы
Успешный запрос: HTTP 200.
Пример ответа — HTTP 200
Сокращённый пример; значения условные.
{
"gigachat": [
"GigaChat"
],
"yandexgpt": [
"yandexgpt-lite"
],
"chatgpt": [
"gpt-4o-mini"
],
"ollama": []
}
Пример списка сокращён. Поле ollama возвращается только при включённой поддержке этого провайдера на сервере. Выберите провайдера, доступного вашему аккаунту; актуальные версии запрашивайте у API.
2. Создать бота
POST /api/v1/bots
URL
https://app.helpfy.ai/api/v1/bots
Заголовки
| Заголовок | Значение |
|---|---|
Authorization | Basic <base64(email:api_key)> |
Accept | application/json |
Content-Type | application/json |
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
name | строка | Да | Понятное название бота. |
gpt_model | строка | Да | Провайдер модели, например yandexgpt. |
primary_language | строка | Нет | Основной язык базы знаний. По умолчанию ru. |
Пример запроса
curl --request POST "https://app.helpfy.ai/api/v1/bots" \
--user "user@example.com:api_key" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-binary @- <<'JSON'
{
"name": "Поддержка интернет-магазина",
"gpt_model": "yandexgpt",
"primary_language": "ru"
}
JSON
Ответы
Успешный запрос: HTTP 201.
Пример ответа — HTTP 201
Сокращённый пример; значения условные.
{
"unique_id": "11111111-1111-4111-8111-111111111111",
"name": "Поддержка интернет-магазина",
"primary_language": "ru"
}
Сохраните unique_id и подставляйте его в адреса следующих запросов. Провайдера существующего бота изменить нельзя. Все параметры создания бота.
3. Получить первый ответ
POST /api/v1/bots/{uniqueId}/completion/sync
URL
https://app.helpfy.ai/api/v1/bots/{uniqueId}/completion/sync
Заголовки
| Заголовок | Значение |
|---|---|
Authorization | Basic <base64(email:api_key)> |
Accept | application/json |
Content-Type | application/json |
Параметры запроса
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
uniqueId | строка | Да | Идентификатор бота в адресе запроса. |
prompt | строка | Да | Сообщение пользователя. |
mode | строка | Нет | Режим ответа: SUPPORT, PROMPTER или DIRECT. По умолчанию PROMPTER. |
Пример запроса
curl --request POST "https://app.helpfy.ai/api/v1/bots/11111111-1111-4111-8111-111111111111/completion/sync" \
--user "user@example.com:api_key" \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data-binary @- <<'JSON'
{
"prompt": "Поздоровайся с клиентом.",
"mode": "DIRECT"
}
JSON
Ответы
Успешный запрос: HTTP 200.
Пример ответа — HTTP 200
Сокращённый пример; значения условные.
{
"response": {
"message": "Здравствуйте! Чем могу помочь?"
},
"meta": {
"prompt": "Поздоровайся с клиентом.",
"mode": "DIRECT"
},
"error": false,
"type": "SUCCESS"
}
Текст ответа может отличаться. Результат находится в response.message; дополнительно проверяйте type и error. После проверки подключения добавьте базу знаний и используйте режим SUPPORT для вопросов клиентов.