Создать сайт-источник

POST /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

Для JSON-тела передайте Content-Type: application/json.

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

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

Тело запроса (application/json)

Поле	Тип	Обязательно	Описание
bot_unique_id	строка	Да	Идентификатор бота.
knowledge_group_unique_id	строка	Да	Идентификатор группы базы знаний.
url	строка	Да	Адрес страницы или сайта для импорта.
scope	PAGE, PATH, HOST	Нет	Область импорта: PAGE — одна страница, PATH — раздел сайта, HOST — весь сайт. (по умолчанию: "PATH")
max_pages	число	Нет	Максимальное количество страниц для импорта. (минимум: 1; максимум: 500; по умолчанию: 200)
is_private_source	логическое значение	Нет	Скрывать ли ссылку на источник в ответах. (по умолчанию: true)
is_indexed	логическое значение	Нет	Участвует ли документ в поиске информации для ответа. (по умолчанию: true)

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

curl --request POST 'https://app.helpfy.ai/api/v1/website-sources' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "bot_unique_id": "11111111-1111-4111-8111-111111111111",
  "knowledge_group_unique_id": "11111111-1111-4111-8111-111111111111",
  "url": "https://docs.example.com/ru/getting-started"
}
JSON

Ответы

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

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

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

{
  "message": "example",
  "data": {
    "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"
  }
}