Перейти к содержимому

HTTP-инструменты

Как собирается запрос инструмента, см. в руководстве по HTTP-инструментам. Пути указаны относительно /api/workspaces/{workspaceId}.

Метод Путь Что делает
GET /tools/ Список инструментов
POST /tools/ Создать инструмент
PATCH /tools/{toolId} Изменить
DELETE /tools/{toolId} Удалить
Окно терминала
curl -X POST https://<host>/api/workspaces/{workspaceId}/tools/ \
-H "Authorization: Bearer $KATA_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{
"name": "get_order",
"description": "Найти заказ по его id.",
"method": "GET",
"url": "https://api.example.com/orders/{orderId}",
"parameters": [
{ "name": "orderId", "type": "string", "description": "Id заказа", "required": true }
]
}'
Поле Обязательное Примечания
name да
url да Может содержать {подстановки}
method нет GET (по умолчанию), POST, PUT, PATCH, DELETE
description нет Подсказывает агенту, когда пользоваться инструментом
parameters нет name, type (string / number / boolean), description, required
access нет Слаг роли → none / read / write. См. ниже

Подключать инструмент к боту не нужно. Каждый бот получает все инструменты, которые разрешены роли человека, для которого он работает. GET считается чтением, остальные методы — записью:

  • none — запуски этой роли инструмента не видят.
  • read — только GET. По умолчанию для всех ролей, кроме администратора.
  • write — любой метод. По умолчанию для администратора.

У владельца всегда write. Запуск, за которым не стоит человек, инструментов не получает. GET /tools/ возвращает access каждого инструмента по ролям; PATCH меняет только названные роли:

Окно терминала
curl -X PATCH https://<host>/api/workspaces/{workspaceId}/tools/{toolId} \
-H "Authorization: Bearer $KATA_API_TOKEN" \
-H "Content-Type: application/json" \
-d '{ "access": { "admin": "write", "member": "none" } }'