Skip to main content
POST
Compile a retrieval rule from natural language

Authorizations

Authorization
string
header
required

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

Query Parameters

stream
boolean

Stream the compilation as Server-Sent Events.

Body

application/json
prompt
string
required
Required string length: 1 - 4000
nodeRef
string
Maximum string length: 255

Response

The compiled rule draft (not yet persisted).

rego_source
string
required
natural_language
string
required
name
string
required
description
string
required
suggested_priority
integer
required
warning
string

Present on the action-facet pre-canned fallback when no AI provider is configured.