monitors

Create a monitor

Starts monitoring a target for changes. When ?stream=1, responds with a text/event-stream provisioning stream instead of the buffered 202.

post/v1/monitors

Request

  • Base URL: https://api.olostep.com
  • URL: https://api.olostep.com/v1/monitors
  • Auth: HTTP bearer

Query parameters

stream'1' | 'true'

When truthy, respond with a provisioning event stream instead of a 202.

Request body

querystring required

What to monitor, in natural language.

frequencystring

Natural-language schedule (e.g. "every day at 9am"). Minimum interval is 10 minutes.

metadataobject
output_schemaobject

JSON Schema for structured extraction output.

Response

Default Response

idstring required
objectstring
querystring required
output_schemaobject nullable
status'provisioning' | 'active' | 'paused' | 'failed' | 'deleted' required
error_messagestring nullable
metadataobject
creatednumber required
updatednumber
total_countnumber
mermaid_diagramstring

Changes

No recorded changes to this operation across all 3 revisions of this API.