Skip to main content
POST
Interpret a monitor from natural language

Authorizations

pubrio-api-key
string
header
required

A unique API token that represents the actions you perform through the API and the corresponding permissions and operations. You can create it through the Settings section.

Body

application/json
query
string
required

The natural-language request (any language), e.g. "monitor companies expanding into Japan, get C-level people with their work email, and email alerts to [email protected] in real time". Capped at 2000 characters.

Maximum string length: 2000
intent
enum<string>

Which action to take (language-agnostic). create_monitor (default): return a draft config. dry_test: draft plus a read-only count of currently matching signals. execute: draft plus preview, flagged for confirmation (never auto-activates). analyze (e.g. "which market, SG or JP?"): answered by the expansion analytical agent instead of building a monitor. If omitted, an English keyword heuristic is used; unrecognised input defaults to create_monitor.

Available options:
create_monitor,
dry_test,
execute,
analyze
deep
boolean

Run the reflection pass for higher accuracy (default true; roughly doubles latency). Set false for a faster single-pass interpretation.

Response

200 - application/json

The interpreted draft. Nothing is persisted.

data
object