Create Monitor

Creates a monitor from a natural-language query. Provisions a shadow agent, generates a workflow spec, queues DAG planning, and schedules recurring runs. Configure delivery with notification.channels and/or webhook. Returns 202 with status provisioning, or stream progress with ?stream=1.

POST /v1/monitors

Create Monitor

cURL

curl --request POST \
  --url https://api.olostep.com/v1/monitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "source_policy": {
    "include_urls": [
      "<string>"
    ],
    "exclude_urls": [
      "<string>"
    ],
    "include_domains": [
      "<string>"
    ],
    "exclude_domains": [
      "<string>"
    ]
  },
  "frequency": "every hour",
  "notification": {
    "events": [],
    "channels": [
      {
        "target": "<string>",
        "events": []
      }
    ]
  },
  "metadata": {},
  "output_schema": {}
}
'

200

"<string>"

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer , where is your auth token.

Query Parameters

stream · enum<string>

When set, the response is text/event-stream with phase, reasoning_token, complete, and error events.

Available options: 1, true

Body

application/json

query · string · required

What to monitor, in natural language.

source_policy · object

Optional URL/domain allow and deny lists applied during planning and execution.

Show child attributes

frequency · string · default: every hour

Natural-language schedule (for example every day at 9am). Minimum interval is every 10 minutes. Schedules use UTC.

Maximum string length: 50

notification · object

Show child attributes

webhook · object

Show child attributes

metadata · object

output_schema · object

JSON Schema for structured extraction output.

Response

200

text/event-stream

Provisioning stream (text/event-stream) when stream=1. Ends with a complete event containing the monitor object.

The response is of type string.