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>",
  "source_policy": {
    "include_urls": [
      "<string>"
    ],
    "exclude_urls": [
      "<string>"
    ],
    "include_domains": [
      "<string>"
    ],
    "exclude_domains": [
      "<string>"
    ]
  },
  "frequency": "every hour",
  "notification": {
    "events": [],
    "channels": [
      {
        "target": "<string>",
        "events": []
      }
    ]
  },
  "metadata": {},
  "output_schema": {}
}
'
"<string>"

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de consulta

stream
enum<string>

Cuando se establece, la respuesta es text/event-stream con eventos de phase, reasoning_token, complete y error.

Opciones disponibles:
1,
true

Cuerpo

application/json
query
string
requerido

Qué monitorear, en lenguaje natural.

source_policy
object

Listas de permitidos y denegados de URL/dominio opcionales aplicadas durante la planificación y ejecución.

frequency
string
predeterminado:every hour

Horario en lenguaje natural (por ejemplo, every day at 9am). El intervalo mínimo es cada 10 minutos. Los horarios usan UTC.

Maximum string length: 50
notification
object
webhook
object
metadata
object
output_schema
object

Esquema JSON para la salida de extracción estructurada.

Respuesta

Flujo de aprovisionamiento (text/event-stream) cuando stream=1. Termina con un evento complete que contiene el objeto del monitor.

The response is of type string.