Получить список документов

GET /api/v1/knowledges

URL

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

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

Заголовки

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

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

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

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

Параметр	Тип	Обязательный	Описание
knowledge_group_unique_id	строка	Нет	Показывать документы только указанной группы.
bot_unique_id	строка	Нет	Показывать записи только указанного бота.
search	строка	Нет	Текст для поиска.
is_private_source	логическое значение	Нет	Отбирать документы по приватности источника: true — ссылка скрыта, false — публичная.
is_indexed	логическое значение	Нет	Отбирать документы по участию в поиске: true — включены, false — отключены.
skip	число	Нет	Количество записей, которые нужно пропустить при просмотре списка.
take	число	Нет	Количество записей, возвращаемых за один запрос.

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

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

Ответы

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

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

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

{
  "data": [
    {
      "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
      "type": "FILE",
      "name": "Руководство пользователя",
      "hash_sum": "7a667b56cecb6137b7486d17b6e4c8a4ff922af1218425a5442b946acbf67860",
      "document_id": "",
      "source": "https://example.com/article/1",
      "is_private_source": true,
      "is_indexed": true,
      "created_at": "2024-10-18T14:13:46.180Z",
      "updated_at": "2024-10-18T14:13:46.180Z",
      "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"
      },
      "content": "Адрес доставки можно изменить до передачи заказа в доставку."
    }
  ],
  "meta": {
    "total": 100,
    "skip": 0,
    "take": 10
  }
}