Skip to main content
POST
Evaluate a retrieval

Authorizations

Authorization
string
header
required

A VisIQ API key presented as Authorization: Bearer vq_prod_.... Mint keys under Connectors -> API Keys in the dashboard.

Body

application/json
agent_id
string
required
Required string length: 1 - 255
operation
enum<string>
required
Available options:
retrieve,
tool_call,
prompt_render
resource_type
string
default:document
Required string length: 1 - 255
resource_metadata
object
trust_tier
string
Maximum string length: 50
surface
string
Maximum string length: 100
query
string
Maximum string length: 2000
session_id
string
Required string length: 1 - 255
telemetry
object

Response

The enforced decision.

decision_id
string<uuid>
required
decision
enum<string>
required

Monitor mode normalizes any non-allow engine outcome to allow.

Available options:
allow,
deny,
redact,
escalate
reason_code
string
required
reason
string
required
redaction_rules
object[]

Present only when decision is redact — the mask directives to apply.

hitl_fallback
enum<string>

Present only when decision is escalate.

Available options:
mask