Получить список ботов

GET /api/v1/bots

Возвращает список ботов текущего пользователя. Поддерживает просмотр по страницам.

URL

https://app.helpfy.ai/api/v1/bots

Адрес своей установки подставьте вместо https://app.helpfy.ai. Идентификаторы в фигурных скобках замените значениями из ответов API.

Заголовки

Заголовок	Значение
Authorization	Basic <base64(email:api_key)>
Accept	application/json

Подробнее — авторизация API.

Параметры запроса

Параметры строки запроса

Параметр	Тип	Обязательный	Описание
search	строка	Нет	Текст для поиска.
skip	число	Нет	Количество пропускаемых записей. По умолчанию 0.
take	число	Нет	Количество возвращаемых записей. По умолчанию 10.
order_by	asc, desc	Нет	Порядок сортировки по дате создания: asc — от старых к новым, desc — от новых к старым. По умолчанию desc.

Пример запроса

curl --request GET 'https://app.helpfy.ai/api/v1/bots' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --get \
  --data-urlencode 'search=Help bot' \
  --data-urlencode 'skip=0'

Ответы

HTTP	Описание
200	Успешный ответ

Пример ответа — HTTP 200

Сокращённый пример; показаны клиентские поля. Значения условные.

{
  "data": [
    {
      "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
      "name": "Main knowledge bot",
      "primary_language": "ru",
      "first_line_greeting_enabled": true,
      "first_line_greeting_text": "Hello! How can I assist you today?",
      "rag_clarify_enabled": true,
      "scenario_clarify_enabled": false,
      "scenario_clarify_min_confidence": 55,
      "scenario_clarify_margin": 12,
      "allow_public_sources_in_support": true,
      "tools_enabled": false,
      "anonymize_pii": false,
      "max_output_tokens": 1000,
      "created_at": "2024-10-18T14:13:46.180Z",
      "updated_at": "2024-10-18T14:13:46.180Z"
    }
  ],
  "meta": {
    "total": 100,
    "skip": 0,
    "take": 10
  }
}