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 '
{
  "frequency": "hourly",
  "query": "<string>",
  "url": "<string>",
  "email": "<string>",
  "webhook_url": "<string>",
  "metadata": {}
}
'
{
  "id": "<string>",
  "object": "monitor",
  "status": "active",
  "agent_id": "<string>",
  "fda_id": "<string>",
  "schedule_id": "<string>",
  "query": "<string>",
  "url": "<string>",
  "frequency": "hourly",
  "cron_expression": "<string>",
  "notification_channel": "email",
  "notification_target": "<string>",
  "metadata": {},
  "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
​
frequency
enum<string>
required
Available options:
hourly,
daily,
weekly
​
query
string

Monitoring intent in natural language. Optional if url is provided.

​
url
string<uri>

URL to monitor. Optional if query is provided.

​
email
string

Notification email. Mutually exclusive with webhook_url.

​
webhook_url
string<uri>

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

​
metadata
object

Response

Monitor accepted and activated.

​
id
string
​
object
string
Example:

"monitor"

​
status
string
Example:

"active"

​
agent_id
string
​
fda_id
string
​
schedule_id
string
​
query
string
​
url
string | null
​
frequency
enum<string>
Available options:
hourly,
daily,
weekly
​
cron_expression
string
​
notification_channel
enum<string>
Available options:
email,
webhook
​
notification_target
string
​
metadata
object
​
created
integer
​
updated
integer