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

GET /api/v1/glossary

Возвращает термины словаря в алфавитном порядке.

URL

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

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

Заголовки

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

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

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

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

Параметр	Тип	Обязательный	Описание
bot_unique_id	строка	Да	Идентификатор бота, модели поведения которого нужно получить.
skip	число	Нет	Количество пропускаемых записей. По умолчанию 0.
take	число	Нет	Количество возвращаемых записей. По умолчанию 10.
order_by	asc, desc	Нет	Порядок сортировки по дате создания: asc — от старых к новым, desc — от новых к старым. По умолчанию desc.

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

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

Ответы

HTTP	Описание
200	Успешный ответ
403	Недостаточно прав для доступа к боту.
404	Бот не найден.

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

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

{
  "data": [
    {
      "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
      "term": "RAG",
      "meaning": "Retrieval-Augmented Generation",
      "created_at": "2024-10-18T14:13:46.180Z",
      "updated_at": "2024-10-18T14:13:46.180Z"
    }
  ],
  "meta": {
    "total": 100,
    "skip": 0,
    "take": 10
  }
}