Получить найденные пары похожих документов

GET /api/v1/knowledge-integrity/semantic-duplicates/journal/{scanId}

Возвращает результат поиска похожих документов с просмотром найденных пар по страницам.

URL

https://app.helpfy.ai/api/v1/knowledge-integrity/semantic-duplicates/journal/{scanId}

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

Заголовки

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

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

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

Параметры пути

Параметр	Тип	Обязательный	Описание
scanId	строка	Да	Идентификатор проверки.

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

Параметр	Тип	Обязательный	Описание
type	MISSING_IN_POSTGRES, MISSING_IN_MYSQL, SEMANTIC_DUPLICATE	Нет	Отбирать найденные проблемы по типу.
skip	число	Нет	Количество записей, которые нужно пропустить при просмотре списка.
take	число	Нет	Количество записей, возвращаемых за один запрос.

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

curl --request GET 'https://app.helpfy.ai/api/v1/knowledge-integrity/semantic-duplicates/journal/11111111-1111-4111-8111-111111111111' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --get \
  --data-urlencode 'type=MISSING_IN_POSTGRES' \
  --data-urlencode 'skip=0'

Ответы

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

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

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

{
  "scan": {
    "unique_id": "7827d9b8-8bb8-428b-984a-7bfcf3221f1f",
    "scope": "GLOBAL",
    "kind": "STRUCTURAL",
    "status": "RUNNING",
    "bot_count": 6,
    "total_knowledges_checked": 4123,
    "total_pairs_checked": 2400,
    "issues_found": 9,
    "started_at": "2026-10-16T09:00:00.000Z"
  },
  "issues": [
    {
      "unique_id": "aef52f8b-9cb9-4ece-95e7-90e4fd8fdb69",
      "type": "MISSING_IN_POSTGRES",
      "created_at": "2026-10-16T09:00:00.000Z"
    }
  ],
  "meta": {
    "total": 100,
    "skip": 0,
    "take": 10
  }
}