Справочник API публикуется на английском языке.
Execute a tool through the gateway
POST
/api/tool-gateway/tools/callPersonal API keyAgent API keyConsole session
Execute a tool through the gateway.
Idempotency. Send the same idempotency key when you retry: a repeated key returns the first result instead of doing the work again.
Авторизация
Send a personal API key or an agent API key as Authorization: Bearer <key>. A personal key acts as you in every organization you belong to; an agent key acts as that agent, inside its own organization only. Как работают ключи.
Тело запроса
application/json · обязательно
toolstringОбязательный
parametersobjectНеобязательный
timeoutMsintegerНеобязательный
> 0approvedActionRequestIdstringНеобязательный
idempotencyKeystringНеобязательный
Ответы
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. Подробнее: ошибки и ограничения.