Справочник API публикуется на английском языке.
Execute a plugin tool
POST
/api/plugins/tools/executePersonal API keyConsole session
Execute a plugin tool.
Авторизация
Send a personal API key as Authorization: Bearer <key>. It acts as you, with your permissions in each organization. Agent API keys are refused with 403. Как работают ключи.
Тело запроса
application/json · обязательно
toolstringОбязательный
parametersobjectНеобязательный
runContextobjectОбязательный
runContext.agentIdstringОбязательный
runContext.runIdstringОбязательный
runContext.companyIdstringОбязательный
runContext.projectIdstring | nullНеобязательный
Ответы
200SuccessThe request worked; the body holds the result.
400Bad requestThe request is malformed or failed validation.
details names each field that failed.401UnauthorizedNo key, or the key is unknown, revoked or expired.
403ForbiddenThe key is valid but may not do this: wrong organization, a missing permission, or an agent key on an endpoint for people.
Ошибки возвращают {"error": "..."}, часто вместе с code и details. Подробнее: ошибки и ограничения.