Naar hoofdinhoud gaan
POST
/
v1
/
monitors
Maak 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.

Autorisaties

​
Authorization
string
header
vereist

Bearer authenticatie header in de vorm Bearer , waar jouw auth token is.

Body

application/json
​
query
string
vereist

Monitoring intent in natuurlijke taal. Als de query een URL bevat, zal de monitor zich op die URL richten.

​
frequency
string
vereist

Schema-instructie in natuurlijke taal (bijvoorbeeld: 'elke dag om 9 uur America/Los_Angeles' of 'elke werkdag om 14:30'). Als er geen tijdzone is opgegeven, wordt UTC gebruikt.

​
email
string

Notificatie e-mail. Wederzijds exclusief met webhook_url en phone_number.

​
webhook_url
string<uri>

Notificatie webhook URL (http/https). Wederzijds exclusief met e-mail en phone_number.

​
phone_number
string

Notificatie telefoonnummer in E.164-formaat (bijvoorbeeld: '+14155552671'). Wanneer opgegeven, worden notificaties via SMS verzonden. Wederzijds exclusief met e-mail en webhook_url.

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

Optioneel JSON-schema dat wordt gebruikt om gestructureerde monitor extractie-uitvoer af te dwingen.

Respons

Monitor geaccepteerd en geactiveerd.

​
id
string
​
object
string
Voorbeeld:

"monitor"

​
status
string
Voorbeeld:

"active"

​
fda_id
string
​
query
string
​
frequency
string

Schema-instructie in natuurlijke taal. Geïnterpreteerd door de planner; standaard naar UTC als er geen tijdzone is opgegeven.

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