Saltar al contenido principal
POST
/
v1
/
monitors
Crear 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.

Autorizaciones

​
Authorization
string
header
requerido

Encabezado de autenticación Bearer de la forma Bearer , donde es tu token de autenticación.

Cuerpo

application/json
​
query
string
requerido

Intención de monitoreo en lenguaje natural. Si la consulta incluye una URL, el monitor se centrará en esa URL.

​
frequency
string
requerido

Instrucción de horario en lenguaje natural (por ejemplo: 'todos los días a las 9am America/Los_Angeles' o 'cada día laborable a las 14:30'). Si no se especifica una zona horaria, se usa UTC.

​
email
string

Correo electrónico de notificación. Mutuamente exclusivo con webhook_url y phone_number.

​
webhook_url
string<uri>

URL de webhook de notificación (http/https). Mutuamente exclusivo con email y phone_number.

​
phone_number
string

Número de teléfono de notificación en formato E.164 (por ejemplo: '+14155552671'). Cuando se proporciona, las notificaciones se envían vía SMS. Mutuamente exclusivo con email y webhook_url.

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

Esquema JSON opcional utilizado para imponer una salida estructurada de extracción del monitor.

Respuesta

Monitor aceptado y activado.

​
id
string
​
object
string
Ejemplo:

"monitor"

​
status
string
Ejemplo:

"active"

​
fda_id
string
​
query
string
​
frequency
string

Instrucción de horario en lenguaje natural. Interpretado por el programador; por defecto usa UTC si no se proporciona una zona horaria.

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