Test tool policy decision

POST/api/companies/{companyId}/tools/policy/test
Personal API keyAgent API keyConsole session
Veyra Docs TeamUpdated Version 3 · History

Test tool policy decision.

Authorization

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

Path parameters

companyIdstringRequiredThe organization's id.

Request body

application/json · required

companyIdstring (uuid)Required
actorobjectRequired
actor.actorTypestringRequiredone of: "agent", "user", "system", "plugin"
actor.actorIdstringRequired1–240 characters
actor.agentIdstring (uuid) | nullOptional
runContextobject | nullOptional
runContext.heartbeatRunIdstring (uuid) | nullOptional
runContext.issueIdstring (uuid) | nullOptional
runContext.projectIdstring (uuid) | nullOptional
runContext.routineIdstring (uuid) | nullOptional
runContext.gatewayIdstring (uuid) | nullOptional
runContext.gatewayPublicIdstring | nullOptional1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
runContext.gatewayTokenIdstring (uuid) | nullOptional
runContext.clientSubjectTypestring | nullOptionalone of: "gateway_client", "heartbeat_run", "board_user", "agent"
runContext.clientSubjectIdstring | nullOptional1–240 characters
runContext.clientNamestring | nullOptional1–160 characters
runContext.externalClientboolean | nullOptional
requestobjectRequired
request.applicationIdstring (uuid) | nullOptional
request.connectionIdstring (uuid) | nullOptional
request.catalogEntryIdstring (uuid) | nullOptional
request.toolNamestringRequired1–240 characters
request.argumentsanyOptional
request.idempotencyKeystring | nullOptional1–512 characters
request.sideEffectingbooleanOptional
consumeRateLimitbooleanOptional
writeAuditEventbooleanOptional

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.
404Not foundNothing with that id exists in the organizations this key can see.

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

Connectors