Изменить источник документа

PATCH /api/v1/knowledges/{uniqueId}/update-source

URL

https://app.helpfy.ai/api/v1/knowledges/{uniqueId}/update-source

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

Заголовки

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

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

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

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

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

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

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

Поле	Тип	Обязательно	Описание
source	строка или null	Нет	Ссылка на исходный материал документа.

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

curl --request PATCH 'https://app.helpfy.ai/api/v1/knowledges/11111111-1111-4111-8111-111111111111/update-source' \
  --user 'user@example.com:api_key' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-binary @- <<'JSON'
{
  "source": "example"
}
JSON

Ответы

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

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

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

{
  "message": "Knowledge source link updated successfully",
  "source": "https://example.com/article/1"
}