Get a virtual key's tool-scan action

GET/v1/virtual-keys/{slug}/tool-scan

Get a virtual key's tool-scan action.

Answers what the tool-result scan does on this key's requests: the key's own action (absent when it uses the platform default), the platform default_action, and the effective_action that applies. MONITOR records what it finds and lets the request through, REDACT removes the matched text from the tool result before the model sees it, and BLOCK refuses the request with 422.

Requires a key of the key's organization with access to its workspace: a workspace key (member or admin) for that workspace, or an organization admin key. 403 without it; 404 when no key has this slug.

Authorization

AuthorizationBearer va_
A platform API key (va_...), created under Settings > API keys. Scoped to an organization or one workspace, with an admin or member role. Used by the management API.

Path parameters

slugstringrequired
the key's slug

Responses

200application/json

virtual_key_slugstring
The virtual key's slug (vk-...).
actionenum<string>
The key's own action; absent when the key uses the platform default.
One of "MONITOR", "REDACT", "BLOCK"
effective_actionenum<string>
What the scan does on this key's requests: action, else default_action.
One of "MONITOR", "REDACT", "BLOCK"
default_actionenum<string>
The platform default, used when the key sets no action of its own.
One of "MONITOR", "REDACT", "BLOCK"

VectorAxis is built by GK Labs, a member of NVIDIA Inception.