Skip to main content
POST
Create a retrieval rule

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
name
string
required
Required string length: 1 - 255
rego_source
string
required
Minimum string length: 1
description
string
Maximum string length: 1000
natural_language
string
Maximum string length: 2000
priority
integer
default:0
enabled
boolean
default:true
trust_tier
string
Maximum string length: 50
surface
string
Maximum string length: 100
principal_exclusions
string[]
Required string length: 1 - 255

Response

The created rule.

id
string<uuid>
name
string
description
string | null
rego_source
string
natural_language
string | null
priority
integer
enabled
boolean
trust_tier
string | null
surface
string | null
principal_exclusions
string[] | null
bypass_active
boolean
bypass_reason
string | null
bypass_activated_by
string | null
bypass_activated_at
string<date-time> | null
bypass_expires_at
string<date-time> | null
created_at
string<date-time>
updated_at
string<date-time>