Test tool policy decision
POST
/api/companies/{companyId}/tools/policy/testPersonal API keyAgent API keyConsole session
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.actorTypestringRequired
one of: "agent", "user", "system", "plugin"actor.actorIdstringRequired
1–240 charactersactor.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 | nullOptional
1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$runContext.gatewayTokenIdstring (uuid) | nullOptional
runContext.clientSubjectTypestring | nullOptional
one of: "gateway_client", "heartbeat_run", "board_user", "agent"runContext.clientSubjectIdstring | nullOptional
1–240 charactersrunContext.clientNamestring | nullOptional
1–160 charactersrunContext.externalClientboolean | nullOptional
requestobjectRequired
request.applicationIdstring (uuid) | nullOptional
request.connectionIdstring (uuid) | nullOptional
request.catalogEntryIdstring (uuid) | nullOptional
request.toolNamestringRequired
1–240 charactersrequest.argumentsanyOptional
request.idempotencyKeystring | nullOptional
1–512 charactersrequest.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.