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>",
  "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>"

Autorisations

Authorization
string
header
requis

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

Paramètres de requête

stream
enum<string>

Lorsqu'il est défini, la réponse est text/event-stream avec des événements phase, reasoning_token, complete, et error.

Options disponibles:
1,
true

Corps

application/json
query
string
requis

Que surveiller, en langage naturel.

source_policy
object

Listes d'autorisation et de refus d'URL/domaine optionnelles appliquées pendant la planification et l'exécution.

frequency
string
défaut:every hour

Calendrier en langage naturel (par exemple every day at 9am). L'intervalle minimum est toutes les 10 minutes. Les calendriers utilisent UTC.

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

Schéma JSON pour la sortie d'extraction structurée.

Réponse

Flux de provisionnement (text/event-stream) lorsque stream=1. Se termine par un événement complete contenant l'objet moniteur.

The response is of type string.