Получить журнал импортов

GET /api/v1/knowledge-transfer

URL

https://app.helpfy.ai/api/v1/knowledge-transfer

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

Заголовки

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

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

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

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

Параметр	Тип	Обязательный	Описание
unique_id	строка	Нет	Фильтр по идентификатору переноса. В текущей реализации ограничение в 32 символа не позволяет передать UUID из ответа API. Используйте фильтр bot_unique_id или получение отдельного переноса по transferId.
bot_unique_id	строка	Да	Отбирать переносы по целевому боту.
skip	число	Нет	Количество записей, которые нужно пропустить при просмотре списка.
take	число	Нет	Количество записей, возвращаемых за один запрос.
status	строка	Нет	Отбирать переносы по статусу.
search	строка	Нет	Поиск по тексту запроса или ответа в журнале.
start_date	строка	Нет	Первый день периода журнала в формате ГГГГ-ММ-ДД.
end_date	строка	Нет	Последний день периода журнала в формате ГГГГ-ММ-ДД.

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

curl --request GET 'https://app.helpfy.ai/api/v1/knowledge-transfer' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --get \
  --data-urlencode 'bot_unique_id=804be633-6f3b-4d38-abf3-8b2709e141fb'

Ответы

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

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

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

{
  "data": [
    {
      "unique_id": "c64a2454-d2c5-4b41-ad4f-6ec22608d4a9",
      "status": "SUCCESS",
      "progress": 45,
      "created_at": "2026-10-16T09:00:00.000Z",
      "updated_at": "2026-10-16T09:00:00.000Z",
      "source_bot": {
        "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"
      },
      "target_bot": {
        "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
  }
}