Zum Hauptinhalt springen
POST
/
v1
/
monitors
Monitor erstellen
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.

Autorisierungen

​
Authorization
string
header
erforderlich

Bearer-Authentifizierungsheader in der Form Bearer , wobei dein Authentifizierungstoken ist.

Body

application/json
​
query
string
erforderlich

Überwachungsabsicht in natürlicher Sprache. Wenn die Abfrage eine URL enthält, konzentriert sich der Monitor auf diese URL.

​
frequency
string
erforderlich

Zeitplananweisung in natürlicher Sprache (zum Beispiel: 'jeden Tag um 9 Uhr America/Los_Angeles' oder 'jeden Wochentag um 14:30'). Wenn keine Zeitzone angegeben ist, wird UTC verwendet.

​
email
string

Benachrichtigungs-E-Mail. Schließt sich gegenseitig mit webhook_url und phone_number aus.

​
webhook_url
string<uri>

Benachrichtigungs-Webhook-URL (http/https). Schließt sich gegenseitig mit E-Mail und phone_number aus.

​
phone_number
string

Benachrichtigungs-Telefonnummer im E.164-Format (zum Beispiel: '+14155552671'). Wenn angegeben, werden Benachrichtigungen per SMS gesendet. Schließt sich gegenseitig mit E-Mail und webhook_url aus.

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

Optionales JSON-Schema, das verwendet wird, um eine strukturierte Monitor-Extraktionsausgabe zu erzwingen.

Antwort

Monitor akzeptiert und aktiviert.

​
id
string
​
object
string
Beispiel:

"monitor"

​
status
string
Beispiel:

"active"

​
fda_id
string
​
query
string
​
frequency
string

Zeitplananweisung in natürlicher Sprache. Wird vom Scheduler interpretiert; verwendet UTC als Standard, wenn keine Zeitzone angegeben ist.

​
cron_expression
string
​
notification_channel
enum<string>
Verfügbare Optionen:
email,
webhook,
sms
​
notification_target
string
​
metadata
object
​
output_schema
object
​
created
integer
​
updated
integer