Создать термин

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

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

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

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

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

Поле	Тип	Обязательно	Описание
bot_unique_id	строка	Да	Идентификатор бота.
term	строка	Да	Термин или сокращение. (минимум символов: 1; максимум символов: 64)
meaning	строка	Да	Значение термина или расшифровка сокращения. (минимум символов: 1; максимум символов: 128)

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

curl --request POST 'https://app.helpfy.ai/api/v1/glossary' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "bot_unique_id": "804be633-6f3b-4d38-abf3-8b2709e141fb",
  "term": "RAG",
  "meaning": "Retrieval-Augmented Generation"
}
JSON

Ответы

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

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

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

{
  "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"
}

Пример ошибки — HTTP 400

Пример структуры ошибки. Код и сообщение зависят от причины ошибки.

{
  "statusCode": 400,
  "error": "Bad Request",
  "code": "BAD_REQUEST",
  "message": "Bad Request"
}