Set a virtual key's tool-scan action

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

Set a virtual key's tool-scan action.

Sets what the tool-result scan does on this key's requests: MONITOR, REDACT or BLOCK. {"action": null} goes back to the platform default. A body without action ({}) changes nothing and answers the current setting.

Requires an organization admin key, or a workspace admin key for the key's workspace.

Errors: 403 without the required role; 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

Request body application/json

the action to set

actionenum<string>
What the scan does when a tool result matches: MONITOR records it, REDACT removes the matched text before the model reads it, BLOCK refuses the request with 422. null means the platform default.
One of "MONITOR", "REDACT", "BLOCK"

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"

Request

curl -X PUT "https://api.vectoraxis.ai/v1/virtual-keys/{slug}/tool-scan" \
  -H "Authorization: Bearer $VECTORAXIS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "action": "MONITOR"
}'

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