Обновить термин

PATCH /api/v1/glossary/{uniqueId}

Изменяет название или значение термина.

URL

https://app.helpfy.ai/api/v1/glossary/{uniqueId}

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

Заголовки

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

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

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

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

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

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

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

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

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

curl --request PATCH 'https://app.helpfy.ai/api/v1/glossary/11111111-1111-4111-8111-111111111111' \
  --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"
}
JSON

Ответы

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

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

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

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