Execute a plugin tool

POST/api/plugins/tools/execute
Personal API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Execute a plugin tool.

Authorization

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. How keys work.

Request body

application/json · required

toolstringRequired
parametersobjectOptional
runContextobjectRequired
runContext.agentIdstringRequired
runContext.runIdstringRequired
runContext.companyIdstringRequired
runContext.projectIdstring | nullOptional

Responses

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.

Errors return {"error": "..."}, often with a code and details. See errors and limits.

Plugins