La referencia de la API se publica en inglés.

Test tool policy decision

POST/api/companies/{companyId}/tools/policy/test
Personal API keyAgent API keyConsole session
Veyra Docs TeamActualizado el Versión 3 · Historial

Test tool policy decision.

Autorización

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. Cómo funcionan las claves.

Parámetros de ruta

companyIdstringObligatorioThe organization's id.

Cuerpo de la solicitud

application/json · obligatorio

companyIdstring (uuid)Obligatorio
actorobjectObligatorio
actor.actorTypestringObligatorioone of: "agent", "user", "system", "plugin"
actor.actorIdstringObligatorio1–240 characters
actor.agentIdstring (uuid) | nullOpcional
runContextobject | nullOpcional
runContext.heartbeatRunIdstring (uuid) | nullOpcional
runContext.issueIdstring (uuid) | nullOpcional
runContext.projectIdstring (uuid) | nullOpcional
runContext.routineIdstring (uuid) | nullOpcional
runContext.gatewayIdstring (uuid) | nullOpcional
runContext.gatewayPublicIdstring | nullOpcional1–120 characterspattern: ^[a-z0-9][a-z0-9._:-]*$
runContext.gatewayTokenIdstring (uuid) | nullOpcional
runContext.clientSubjectTypestring | nullOpcionalone of: "gateway_client", "heartbeat_run", "board_user", "agent"
runContext.clientSubjectIdstring | nullOpcional1–240 characters
runContext.clientNamestring | nullOpcional1–160 characters
runContext.externalClientboolean | nullOpcional
requestobjectObligatorio
request.applicationIdstring (uuid) | nullOpcional
request.connectionIdstring (uuid) | nullOpcional
request.catalogEntryIdstring (uuid) | nullOpcional
request.toolNamestringObligatorio1–240 characters
request.argumentsanyOpcional
request.idempotencyKeystring | nullOpcional1–512 characters
request.sideEffectingbooleanOpcional
consumeRateLimitbooleanOpcional
writeAuditEventbooleanOpcional

Respuestas

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.

Los errores devuelven {"error": "..."}, a menudo con un code y unos details. Consulta errores y límites.

Connectors