Получить список сайтов-источников

GET /api/v1/website-sources

URL

https://app.helpfy.ai/api/v1/website-sources

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

Заголовки

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

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

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

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

Параметр	Тип	Обязательный	Описание
bot_unique_id	строка	Да	Уникальный идентификатор бота.
knowledge_group_unique_id	строка	Да	Идентификатор группы базы знаний.

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

curl --request GET 'https://app.helpfy.ai/api/v1/website-sources' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --get \
  --data-urlencode 'bot_unique_id=804be633-6f3b-4d38-abf3-8b2709e141fb' \
  --data-urlencode 'knowledge_group_unique_id=ca8d4d20-edc0-41ca-a672-140786bc17e3'

Ответы

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

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

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

[
  {
    "unique_id": "11111111-1111-4111-8111-111111111111",
    "start_url": "https://example.com/endpoint",
    "allowed_origin": "example",
    "path_prefix": "example",
    "scope": "PAGE",
    "max_pages": 1,
    "is_private_source": false,
    "is_indexed": false,
    "ignore_robots": false,
    "status": "PENDING",
    "pages_discovered": 1,
    "pages_imported": 1,
    "pages_unchanged": 1,
    "pages_failed": 1,
    "pages_skipped": 1,
    "created_at": "2026-10-16T09:00:00.000Z",
    "updated_at": "2026-10-16T09:00:00.000Z"
  }
]