Обновить функцию

PATCH /api/v1/bot-tools/{uniqueId}

URL

https://app.helpfy.ai/api/v1/bot-tools/{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	строка	Нет	Идентификатор бота, которому принадлежит функция.
name	строка	Нет	Название функции, которое видит модель.
description	строка	Нет	Краткое описание, доступное модели и в интерфейсе.
strict	логическое значение	Нет	Включена ли строгая проверка схемы аргументов.
is_enabled	логическое значение	Нет	Включена ли функция.
request_method	GET, POST, PUT, PATCH, DELETE	Нет	HTTP-метод внешнего запроса функции.
request_url	строка	Нет	HTTPS-адрес внешнего сервиса с возможностью подстановки аргументов.
input_schema_json	объект	Нет	Схема JSON, по которой модель передаёт аргументы функции.
request_body_template	строка	Нет	Шаблон JSON-тела внешнего запроса с подстановкой аргументов.
response_path	строка	Нет	Путь к нужному полю ответа через точку, например data.status.
timeout_ms	число	Нет	Время ожидания ответа внешнего сервиса в миллисекундах.
max_response_bytes	число	Нет	Максимальный размер ответа внешнего сервиса в байтах.
headers	массив: объект	Нет	Заголовки для запроса к внешнему сервису.

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

curl --request PATCH 'https://app.helpfy.ai/api/v1/bot-tools/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",
  "name": "get_weather"
}
JSON

Ответы

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

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

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

{
  "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
  "name": "get_weather",
  "description": "Возвращает погоду в указанном городе.",
  "strict": true,
  "is_enabled": true,
  "request_method": "POST",
  "request_url": "https://api.example.com/weather?city={location}",
  "input_schema_json": {
    "type": "object",
    "properties": {
      "location": {
        "type": "string"
      }
    }
  },
  "timeout_ms": 5000,
  "max_response_bytes": 65536,
  "allow_redirects": false,
  "headers": [
    {
      "unique_id": "17396bcc-6b29-4b2e-b7fd-63c8eb8b6cc8",
      "header_name": "Content-Type",
      "is_secret": false,
      "is_enabled": true,
      "has_value": true
    }
  ],
  "created_at": "2024-10-18T14:13:46.180Z",
  "updated_at": "2024-10-18T14:13:46.180Z"
}