Passer au contenu principal
POST
/
v1
/
monitors
Créer un Moniteur
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.

Autorisations

​
Authorization
string
header
requis

En-tête d'authentification Bearer sous la forme Bearer , où est ton jeton d'authentification.

Corps

application/json
​
query
string
requis

Intention de surveillance en langage naturel. Si la requête inclut une URL, le moniteur se concentrera sur cette URL.

​
frequency
string
requis

Instruction de planning en langage naturel (par exemple : 'tous les jours à 9h America/Los_Angeles' ou 'chaque jour de la semaine à 14:30'). Si aucun fuseau horaire n'est spécifié, UTC est utilisé.

​
email
string

Email de notification. Mutuellement exclusif avec webhook_url et phone_number.

​
webhook_url
string<uri>

URL de webhook de notification (http/https). Mutuellement exclusif avec email et phone_number.

​
phone_number
string

Numéro de téléphone de notification au format E.164 (par exemple : '+14155552671'). Lorsqu'il est fourni, les notifications sont envoyées par SMS. Mutuellement exclusif avec email et webhook_url.

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

Schéma JSON optionnel utilisé pour imposer une sortie structurée de l'extraction du moniteur.

Réponse

Moniteur accepté et activé.

​
id
string
​
object
string
Exemple:

"monitor"

​
status
string
Exemple:

"active"

​
fda_id
string
​
query
string
​
frequency
string

Instruction de planning en langage naturel. Interprétée par le planificateur ; utilise UTC par défaut si aucun fuseau horaire n'est fourni.

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