Skip to main content
POST
/
v1
/
monitors
Create Monitor
curl --request POST \
  --url https://api.olostep.com/v1/monitors \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "query": "<string>",
  "frequency": "<string>",
  "email": "<string>",
  "webhook_url": "<string>",
  "phone_number": "<string>",
  "metadata": {},
  "output_schema": {}
}
'
{
  "id": "<string>",
  "object": "monitor",
  "status": "active",
  "fda_id": "<string>",
  "query": "<string>",
  "frequency": "<string>",
  "cron_expression": "<string>",
  "notification_target": "<string>",
  "metadata": {},
  "output_schema": {},
  "created": 123,
  "updated": 123
}

Documentation Index

Fetch the complete documentation index at: https://docs.olostep.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Body

application/json
​
query
string
required

Monitoring intent in natural language. If the query includes a URL, the monitor will focus on that URL.

​
frequency
string
required

Natural-language schedule instruction (for example: 'every day at 9am America/Los_Angeles' or 'every weekday at 14:30'). If no timezone is specified, UTC is used.

​
email
string

Notification email. Mutually exclusive with webhook_url and phone_number.

​
webhook_url
string<uri>

Notification webhook URL (http/https). Mutually exclusive with email and phone_number.

​
phone_number
string

Notification phone number in E.164 format (for example: '+14155552671'). When provided, notifications are sent via SMS. Mutually exclusive with email and webhook_url.

Pattern: ^\+[1-9]\d{1,14}$
​
metadata
object
​
output_schema
object

Optional JSON schema used to enforce structured monitor extraction output.

Response

Monitor accepted and activated.

​
id
string
​
object
string
Example:

"monitor"

​
status
string
Example:

"active"

​
fda_id
string
​
query
string
​
frequency
string

Natural-language schedule instruction. Interpreted by the scheduler; defaults to UTC if no timezone is provided.

​
cron_expression
string
​
notification_channel
enum<string>
Available options:
email,
webhook,
sms
​
notification_target
string
​
metadata
object
​
output_schema
object
​
created
integer
​
updated
integer