Creates a monitor from a natural-language query. Provisions a shadow agent, generates a workflow spec, queues DAG planning, and schedules recurring runs. Configure delivery with notification.channels and/or webhook. Returns 202 with status provisioning, or stream progress with ?stream=1.
Provisioning stream (text/event-stream) when stream=1. Ends with a complete event containing the monitor object.
The response is of type string.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Olostep Docs","description":"Olostep: infrastructure for the Web's second user. Search, scraping and crawling API for AI.","colors":{"primary":"#9563FF","light":"#AE87FF","dark":"#0D001D"},"logo":{"light":"https://mintcdn.com/olostep-58/294AdrknPYBl2RjK/logo/light.svg?fit=max\u0026auto=format\u0026n=294AdrknPYBl2RjK\u0026q=85\u0026s=fad5e5ee72a916722d9ad8279ee7186d","dark":"https://mintcdn.com/olostep-58/294AdrknPYBl2RjK/logo/dark.svg?fit=max\u0026auto=format\u0026n=294AdrknPYBl2RjK\u0026q=85\u0026s=dc0971e24a94b91a46d7dd802d74b94f","href":"https://www.olostep.com/"},"favicon":"https://mintcdn.com/olostep-58/l2r9Xs_8Kg7J6BE0/favicon.png?fit=max\u0026auto=format\u0026n=l2r9Xs_8Kg7J6BE0\u0026q=85\u0026s=b460adce2b36180de42d09cad6bc4f46","background":{"color":{"dark":"#090014"}},"navbar":{"links":[{"href":"https://www.olostep.com/pricing","label":"Pricing"}],"primary":{"type":"button","label":"Get Started","href":"https://www.olostep.com/auth"}},"footer":{"socials":{"github":"https://github.com/olostep-api","website":"https://www.olostep.com"}},"seo":{"metatags":{"robots":"index, follow","googlebot":"index, follow","og:site_name":"Olostep Docs","twitter:card":"summary_large_image"},"indexing":"navigable"},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":false},"navigation":{"global":{"anchors":[{"anchor":"Playground","icon":"play","href":"https://www.olostep.com/playground"},{"anchor":"Join Community","icon":"slack","href":"https://olostep-users.slack.com/join/shared_invite/zt-2bfddyi8h-JzfjOgavg~98DJ1om1B5Lg#/shared-invite/email"},{"anchor":"Blog","icon":"newspaper","href":"https://www.olostep.com/blog"}]},"languages":[{"language":"en","default":true,"href":"get-started/welcome"},{"language":"de","href":"de/get-started/welcome"},{"language":"fr","href":"fr/get-started/welcome"},{"language":"es","href":"es/get-started/welcome"},{"language":"nl","href":"nl/get-started/welcome"},{"language":"zh","href":"zh/get-started/welcome"},{"language":"it","href":"it/get-started/welcome"},{"language":"ja","href":"ja/get-started/welcome"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"olostep-58","hasAudioNarration":false,"actualSubdomain":"olostep-58","customDomains":["docs.olostep.com"],"gitSource":{"type":"github","owner":"olostep","repo":"docs","deployBranch":"prod","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae63f26cf4408c76828b558","collectionId":"838fe12b-31a1-4a2f-8c84-cea4682bc08d","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae63f26cf4408c76828b558"},"feedback":{"edits":false,"issues":false,"thumbs":true},"entitlements":{},"buildId":"6ae7761a8e7709423eef338b","clientVersion":"0.0.4044","searchFilterCounts":[{"language":"en","tag":"API Reference","count":43},{"language":"de","tag":"API-Referenz","count":43},{"language":"es","tag":"Referencia de API","count":43},{"language":"fr","tag":"Référence API","count":43},{"language":"it","tag":"Riferimento API","count":43},{"language":"ja","tag":"APIリファレンス","count":43},{"language":"nl","tag":"API-referentie","count":43},{"language":"zh","tag":"API参考","count":43},{"language":"en","tag":"Integrations","count":32},{"language":"de","tag":"Integrationen","count":32},{"language":"es","tag":"Integraciones","count":32},{"language":"fr","tag":"Intégrations","count":32},{"language":"it","tag":"Integrazioni","count":32},{"language":"ja","tag":"統合","count":32},{"language":"nl","tag":"Integraties","count":32},{"language":"zh","tag":"集成","count":32},{"language":"en","tag":"Documentation","count":20},{"language":"en","tag":"Examples","count":20},{"language":"de","tag":"Dokumentation","count":20},{"language":"de","tag":"Beispiele","count":20},{"language":"es","tag":"Documentación","count":20},{"language":"es","tag":"Ejemplos","count":20},{"language":"fr","tag":"Documentation","count":20},{"language":"fr","tag":"Exemples","count":20},{"language":"it","tag":"Documentazione","count":20},{"language":"it","tag":"Esempi","count":20},{"language":"ja","tag":"ドキュメント","count":20},{"language":"ja","tag":"例","count":20},{"language":"nl","tag":"Documentatie","count":20},{"language":"nl","tag":"Voorbeelden","count":20},{"language":"zh","tag":"文档","count":20},{"language":"zh","tag":"示例","count":20},{"language":"en","tag":"Features","count":15},{"language":"de","tag":"Funktionen","count":15},{"language":"es","tag":"Características","count":15},{"language":"fr","tag":"Fonctionnalités","count":15},{"language":"it","tag":"Funzionalità","count":15},{"language":"ja","tag":"機能","count":15},{"language":"nl","tag":"Functies","count":15},{"language":"zh","tag":"功能","count":15},{"language":"en","tag":"Monitors","count":11},{"language":"de","tag":"Monitore","count":11},{"language":"es","tag":"Monitores","count":11},{"language":"fr","tag":"Moniteurs","count":11},{"language":"it","tag":"Monitor","count":11},{"language":"ja","tag":"モニター","count":11},{"language":"nl","tag":"Monitoren","count":11},{"language":"zh","tag":"显示器","count":11},{"language":"en","tag":"CLI","count":10},{"language":"de","tag":"Befehlszeilenschnittstelle","count":10},{"language":"es","tag":"CLI","count":10},{"language":"fr","tag":"Ligne de commande","count":10},{"language":"it","tag":"Interfaccia a riga di comando","count":10},{"language":"ja","tag":"CLI","count":10},{"language":"nl","tag":"CLI","count":10},{"language":"zh","tag":"命令行界面","count":10},{"language":"en","tag":"Files","count":6},{"language":"en","tag":"SDKs","count":6},{"language":"de","tag":"Dateien","count":6},{"language":"de","tag":"SDKs","count":6},{"language":"es","tag":"Archivos","count":6},{"language":"es","tag":"SDKs","count":6},{"language":"fr","tag":"Fichiers","count":6},{"language":"fr","tag":"SDKs","count":6},{"language":"it","tag":"File","count":6},{"language":"it","tag":"SDK","count":6},{"language":"ja","tag":"ファイル","count":6},{"language":"ja","tag":"SDKs","count":6},{"language":"nl","tag":"Bestanden","count":6},{"language":"nl","tag":"SDK's","count":6},{"language":"zh","tag":"文件","count":6},{"language":"zh","tag":"SDKs","count":6},{"language":"en","tag":"Olostep CLI","count":5},{"language":"de","tag":"Olostep-Befehlszeilenschnittstelle","count":5},{"language":"es","tag":"Olostep CLI","count":5},{"language":"fr","tag":"Olostep CLI","count":5},{"language":"it","tag":"Olostep CLI","count":5},{"language":"ja","tag":"Olostep CLI","count":5},{"language":"nl","tag":"Olostep CLI","count":5},{"language":"zh","tag":"Olostep 命令行界面","count":5}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/monitors/create","slug":"/api-reference/monitors/create","pageMetadata":{"title":"Create Monitor","description":"Creates a monitor from a natural-language query. Provisions a shadow agent, generates a workflow spec, queues DAG planning, and schedules recurring runs. Configure delivery with notification.channels and/or webhook. Returns 202 with status provisioning, or stream progress with ?stream=1.","openapi":"openapi/monitors.json POST /v1/monitors","href":"/api-reference/monitors/create"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Creates a monitor from a natural-language query. Provisions a shadow agent, generates a workflow spec, queues DAG planning, and schedules recurring runs. Configure delivery with notification.channels and/or webhook. Returns 202 with status provisioning, or stream progress with ?stream=1.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Create Monitor","description":"Creates a monitor from a natural-language query. Provisions a shadow agent, generates a workflow spec, queues DAG planning, and schedules recurring runs. Configure delivery with notification.channels and/or webhook. Returns 202 with status provisioning, or stream progress with ?stream=1.","openapi":"openapi/monitors.json POST /v1/monitors","href":"/api-reference/monitors/create"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Create Monitor","description":"Creates a monitor from a natural-language query. Provisions a shadow agent, generates a workflow spec, queues DAG planning, and schedules recurring runs. Configure delivery with notification.channels and/or webhook. Returns 202 with status provisioning, or stream progress with ?stream=1.","security":["cae9c957-9443-4a3b-a573-dd2bb33f47de"],"parameters":["4afb26ed-6690-47e0-9a7e-ff9980deecff"],"requestBody":"26abbe3f-2b61-4f62-a9ca-ab15dfdd7ef7","responses":{"200":"e7d182eb-2a2d-4bef-b2c6-73308a7f4c15","202":"9ba7155d-0be6-445e-89f3-efde65e269f4","400":"927dab0d-45cc-4de8-b3fd-a26d0ccdf43c","401":"528bd77a-a36f-4358-95aa-6bf2f38ef200","500":"4a220f08-7e0a-4d0a-bf9d-3b888dc44971","503":"7b568715-9c90-4fbc-b9c0-5c04e8c8d9cb"},"method":"post","type":"path","servers":["a3683e04-4ed2-447c-ba46-99b8b5e2692b"],"path":"/v1/monitors","baseUrlOptions":["https://api.olostep.com"],"title":"Create Monitor","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"4afb26ed-6690-47e0-9a7e-ff9980deecff":{"name":"stream","in":"query","required":false,"schema":{"type":"string","enum":["1","true"],"isRequired":false,"description":"When set, the response is `text/event-stream` with `phase`, `reasoning_token`, `complete`, and `error` events.","uniqueKey":"","typeLabel":"enum\u003cstring>"},"description":"When set, the response is `text/event-stream` with `phase`, `reasoning_token`, `complete`, and `error` events."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["query"],"properties":{"query":{"type":"string","description":"What to monitor, in natural language.","isRequired":true,"uniqueKey":"query","typeLabel":"string"},"source_policy":{"type":"object","description":"Optional URL/domain allow and deny lists applied during planning and execution.","properties":{"include_urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"source_policy.include_urls.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"source_policy.include_urls","typeLabel":"string\u003curi>[]"},"exclude_urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"source_policy.exclude_urls.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"source_policy.exclude_urls","typeLabel":"string\u003curi>[]"},"include_domains":{"type":"array","items":{"type":"string","uniqueKey":"source_policy.include_domains.items.[INDEX]","typeLabel":"string"},"uniqueKey":"source_policy.include_domains","typeLabel":"string[]"},"exclude_domains":{"type":"array","items":{"type":"string","uniqueKey":"source_policy.exclude_domains.items.[INDEX]","typeLabel":"string"},"uniqueKey":"source_policy.exclude_domains","typeLabel":"string[]"}},"uniqueKey":"source_policy","typeLabel":"object"},"frequency":{"type":"string","maxLength":50,"default":"every hour","description":"Natural-language schedule (for example `every day at 9am`). Minimum interval is every 10 minutes. Schedules use UTC.","uniqueKey":"frequency","typeLabel":"string"},"notification":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"],"uniqueKey":"notification.events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"When to notify. `changed` — deliver when a change is detected vs. the previous snapshot. `first_snapshot` — deliver when the first baseline snapshot is taken. Defaults to both when `channels` is non-empty and `events` is empty.","uniqueKey":"notification.events","typeLabel":"enum\u003cstring>[]"},"channels":{"type":"array","items":{"type":"object","required":["type","target"],"properties":{"type":{"type":"string","enum":["email","slack","sms"],"description":"Delivery channel type.","isRequired":true,"uniqueKey":"notification.channels.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"target":{"type":"string","description":"Email address, Slack webhook URL, or E.164 phone number (for SMS).","isRequired":true,"uniqueKey":"notification.channels.items.[INDEX].target","typeLabel":"string"},"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"],"uniqueKey":"notification.channels.items.[INDEX].events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Optional per-channel event filter. When omitted, channel delivery follows top-level `notification.events` (or defaults when channels are set).","uniqueKey":"notification.channels.items.[INDEX].events","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"notification.channels.items.[INDEX]","typeLabel":"object"},"description":"Email, Slack, or SMS delivery targets. Resolved at runtime by the monitor pipeline.","uniqueKey":"notification.channels","typeLabel":"object[]"}},"uniqueKey":"notification","typeLabel":"object"},"webhook":{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"HTTP/HTTPS URL that receives monitor payloads (separate from `notification.channels`).","isRequired":true,"uniqueKey":"webhook.url","typeLabel":"string\u003curi>"}},"uniqueKey":"webhook","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":true,"uniqueKey":"metadata","typeLabel":"object"},"output_schema":{"type":"object","additionalProperties":true,"description":"JSON Schema for structured extraction output.","uniqueKey":"output_schema","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"query":"\u003cstring>","source_policy":{"include_urls":["\u003cstring>"],"exclude_urls":["\u003cstring>"],"include_domains":["\u003cstring>"],"exclude_domains":["\u003cstring>"]},"frequency":"every hour","notification":{"events":[],"channels":[{"target":"\u003cstring>","events":[]}]},"metadata":{},"output_schema":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"e7d182eb-2a2d-4bef-b2c6-73308a7f4c15":{"description":"Provisioning stream (`text/event-stream`) when `stream=1`. Ends with a `complete` event containing the monitor object.","content":{"text/event-stream":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"}},"exampleType":"generated"},"9ba7155d-0be6-445e-89f3-efde65e269f4":{"description":"Monitor accepted; provisioning started (non-streaming).","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Unique monitor identifier (`monitor_…`).","uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","example":"monitor","uniqueKey":"object","typeLabel":"string"},"query":{"type":"string","description":"Monitoring intent in natural language.","uniqueKey":"query","typeLabel":"string"},"tracked":{"type":"object","description":"Resolved targets the monitor tracks after planning completes.","properties":{"type":{"oneOf":[{"type":"string","description":"Tracked surface type (for example `url` or `web_query`).","uniqueKey":"tracked.type.oneOf.0","typeLabel":"string"},{"type":"null","description":"Tracked surface type (for example `url` or `web_query`).","uniqueKey":"tracked.type.oneOf.1","typeLabel":"null"}],"uniqueKey":"tracked.type","typeLabel":"string | null"},"urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"tracked.urls.items.[INDEX]","typeLabel":"string\u003curi>"},"description":"Concrete URLs being monitored.","uniqueKey":"tracked.urls","typeLabel":"string\u003curi>[]"},"web_query":{"oneOf":[{"type":"string","description":"Web search query used when the monitor tracks a dynamic result set.","uniqueKey":"tracked.web_query.oneOf.0","typeLabel":"string"},{"type":"null","description":"Web search query used when the monitor tracks a dynamic result set.","uniqueKey":"tracked.web_query.oneOf.1","typeLabel":"null"}],"uniqueKey":"tracked.web_query","typeLabel":"string | null"}},"uniqueKey":"tracked","typeLabel":"object"},"source_policy":{"type":"object","description":"Optional URL/domain allow and deny lists applied during planning and execution.","properties":{"include_urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"source_policy.include_urls.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"source_policy.include_urls","typeLabel":"string\u003curi>[]"},"exclude_urls":{"type":"array","items":{"type":"string","format":"uri","uniqueKey":"source_policy.exclude_urls.items.[INDEX]","typeLabel":"string\u003curi>"},"uniqueKey":"source_policy.exclude_urls","typeLabel":"string\u003curi>[]"},"include_domains":{"type":"array","items":{"type":"string","uniqueKey":"source_policy.include_domains.items.[INDEX]","typeLabel":"string"},"uniqueKey":"source_policy.include_domains","typeLabel":"string[]"},"exclude_domains":{"type":"array","items":{"type":"string","uniqueKey":"source_policy.exclude_domains.items.[INDEX]","typeLabel":"string"},"uniqueKey":"source_policy.exclude_domains","typeLabel":"string[]"}},"uniqueKey":"source_policy","typeLabel":"object"},"schedule":{"type":"object","properties":{"frequency":{"oneOf":[{"type":"string","description":"Natural-language schedule text (for example `every hour`).","uniqueKey":"schedule.frequency.oneOf.0","typeLabel":"string"},{"type":"null","description":"Natural-language schedule text (for example `every hour`).","uniqueKey":"schedule.frequency.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule.frequency","typeLabel":"string | null"},"cron":{"oneOf":[{"type":"string","description":"Cron expression derived from `frequency`.","uniqueKey":"schedule.cron.oneOf.0","typeLabel":"string"},{"type":"null","description":"Cron expression derived from `frequency`.","uniqueKey":"schedule.cron.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule.cron","typeLabel":"string | null"},"timezone":{"type":"string","example":"UTC","description":"Schedule timezone. Currently `UTC` for monitor schedules.","uniqueKey":"schedule.timezone","typeLabel":"string"},"next_run_at":{"oneOf":[{"type":"string","format":"date-time","description":"Next scheduled run (ISO 8601). `null` when the monitor is not `active`.","uniqueKey":"schedule.next_run_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","description":"Next scheduled run (ISO 8601). `null` when the monitor is not `active`.","uniqueKey":"schedule.next_run_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"schedule.next_run_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"schedule","typeLabel":"object"},"notification":{"type":"object","properties":{"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"],"uniqueKey":"notification.events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"When to notify. `changed` — deliver when a change is detected vs. the previous snapshot. `first_snapshot` — deliver when the first baseline snapshot is taken. Defaults to both when `channels` is non-empty and `events` is empty.","uniqueKey":"notification.events","typeLabel":"enum\u003cstring>[]"},"channels":{"type":"array","items":{"type":"object","required":["type","target"],"properties":{"type":{"type":"string","enum":["email","slack","sms"],"description":"Delivery channel type.","isRequired":true,"uniqueKey":"notification.channels.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"target":{"type":"string","description":"Email address, Slack webhook URL, or E.164 phone number (for SMS).","isRequired":true,"uniqueKey":"notification.channels.items.[INDEX].target","typeLabel":"string"},"events":{"type":"array","items":{"type":"string","enum":["changed","first_snapshot"],"uniqueKey":"notification.channels.items.[INDEX].events.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Optional per-channel event filter. When omitted, channel delivery follows top-level `notification.events` (or defaults when channels are set).","uniqueKey":"notification.channels.items.[INDEX].events","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"notification.channels.items.[INDEX]","typeLabel":"object"},"description":"Email, Slack, or SMS delivery targets. Resolved at runtime by the monitor pipeline.","uniqueKey":"notification.channels","typeLabel":"object[]"}},"uniqueKey":"notification","typeLabel":"object"},"webhook":{"oneOf":[{"type":"object","required":["url"],"properties":{"url":{"type":"string","format":"uri","description":"HTTP/HTTPS URL that receives monitor payloads (separate from `notification.channels`).","isRequired":true,"uniqueKey":"webhook.oneOf.0.url","typeLabel":"string\u003curi>"}},"uniqueKey":"webhook.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"webhook.oneOf.1","typeLabel":"null"}],"uniqueKey":"webhook","typeLabel":"object | null"},"output_schema":{"oneOf":[{"type":"object","additionalProperties":true,"description":"Optional JSON Schema for structured extraction output.","uniqueKey":"output_schema.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":true,"description":"Optional JSON Schema for structured extraction output.","uniqueKey":"output_schema.oneOf.1","typeLabel":"null"}],"uniqueKey":"output_schema","typeLabel":"object | null"},"status":{"type":"string","enum":["provisioning","active","paused","failed","deleted"],"description":"Monitor lifecycle status.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"error_message":{"oneOf":[{"type":"string","description":"Present when `status` is `failed`.","uniqueKey":"error_message.oneOf.0","typeLabel":"string"},{"type":"null","description":"Present when `status` is `failed`.","uniqueKey":"error_message.oneOf.1","typeLabel":"null"}],"uniqueKey":"error_message","typeLabel":"string | null"},"last_run":{"oneOf":[{"type":"object","description":"Latest snapshot summary. Included on `GET /v1/monitors/{monitor_id}`.","properties":{"id":{"oneOf":[{"type":"string","description":"Run ID of the latest snapshot (`run_…`).","uniqueKey":"last_run.oneOf.0.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Run ID of the latest snapshot (`run_…`).","uniqueKey":"last_run.oneOf.0.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_run.oneOf.0.id","typeLabel":"string | null"},"status":{"type":"string","example":"completed","uniqueKey":"last_run.oneOf.0.status","typeLabel":"string"},"change_detected":{"oneOf":[{"type":"boolean","uniqueKey":"last_run.oneOf.0.change_detected.oneOf.0","typeLabel":"boolean"},{"type":"null","uniqueKey":"last_run.oneOf.0.change_detected.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_run.oneOf.0.change_detected","typeLabel":"boolean | null"},"ran_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"last_run.oneOf.0.ran_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"last_run.oneOf.0.ran_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_run.oneOf.0.ran_at","typeLabel":"string\u003cdate-time> | null"}},"uniqueKey":"last_run.oneOf.0","typeLabel":"object"},{"type":"null","uniqueKey":"last_run.oneOf.1","typeLabel":"null"}],"uniqueKey":"last_run","typeLabel":"object | null"},"agent":{"type":"object","properties":{"id":{"oneOf":[{"type":"string","description":"Internal shadow agent ID used to execute the monitor DAG.","uniqueKey":"agent.id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Internal shadow agent ID used to execute the monitor DAG.","uniqueKey":"agent.id.oneOf.1","typeLabel":"null"}],"uniqueKey":"agent.id","typeLabel":"string | null"}},"uniqueKey":"agent","typeLabel":"object"},"metadata":{"type":"object","additionalProperties":true,"uniqueKey":"metadata","typeLabel":"object"},"created":{"type":"integer","description":"Unix timestamp (seconds).","uniqueKey":"created","typeLabel":"integer"},"updated":{"type":"integer","description":"Unix timestamp (seconds).","uniqueKey":"updated","typeLabel":"integer"},"total_count":{"type":"integer","description":"Total snapshot count. Included on `GET /v1/monitors/{monitor_id}` unless `include_total_count=false`.","uniqueKey":"total_count","typeLabel":"integer"},"mermaid_diagram":{"type":"string","description":"Mermaid flowchart of the monitor DAG. Included when `include-diagram=true` on get.","uniqueKey":"mermaid_diagram","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","object":"monitor","query":"\u003cstring>","tracked":{"type":"\u003cstring>","urls":["\u003cstring>"],"web_query":"\u003cstring>"},"source_policy":{"include_urls":["\u003cstring>"],"exclude_urls":["\u003cstring>"],"include_domains":["\u003cstring>"],"exclude_domains":["\u003cstring>"]},"schedule":{"frequency":"\u003cstring>","cron":"\u003cstring>","timezone":"UTC","next_run_at":"2023-11-07T05:31:56Z"},"notification":{"events":["changed"],"channels":[{"type":"email","target":"\u003cstring>","events":["changed"]}]},"webhook":{"url":"\u003cstring>"},"output_schema":{},"status":"provisioning","error_message":"\u003cstring>","last_run":{"id":"\u003cstring>","status":"completed","change_detected":true,"ran_at":"2023-11-07T05:31:56Z"},"agent":{"id":"\u003cstring>"},"metadata":{},"created":123,"updated":123,"total_count":123,"mermaid_diagram":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"927dab0d-45cc-4de8-b3fd-a26d0ccdf43c":{"description":"Invalid request (query, frequency, source_policy, notification, webhook, metadata, or output_schema).","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"string","uniqueKey":"error","typeLabel":"string"},"monitor_id":{"type":"string","description":"Present on some create/update error responses.","uniqueKey":"monitor_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":"\u003cstring>","monitor_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"528bd77a-a36f-4358-95aa-6bf2f38ef200":{"description":"Invalid API key.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"4a220f08-7e0a-4d0a-bf9d-3b888dc44971":{"description":"Internal server error while creating monitor.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"7b568715-9c90-4fbc-b9c0-5c04e8c8d9cb":{"description":"FDA master agent unavailable during provisioning.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}}},"security":{"cae9c957-9443-4a3b-a573-dd2bb33f47de":{"Authorization":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form Bearer \u003ctoken>, where \u003ctoken> is your auth token.","scopes":[]}}},"servers":{"a3683e04-4ed2-447c-ba46-99b8b5e2692b":{"url":"https://api.olostep.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer authentication header of the form Bearer \u003ctoken>, where \u003ctoken> is your auth token.","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form Bearer \u003ctoken>, where \u003ctoken> is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Authorization","name":"Authorization"}],"title":"Authorization"}]},"originalFileLocation":"openapi/monitors.json"},"subdomain":"olostep-58","siteName":"Olostep Docs","title":"Create Monitor - Olostep Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/monitors/create","matchLevel":0},"de":{"href":"/de/api-reference/monitors/create","matchLevel":1},"fr":{"href":"/fr/api-reference/monitors/create","matchLevel":1},"es":{"href":"/es/api-reference/monitors/create","matchLevel":1},"nl":{"href":"/nl/api-reference/monitors/create","matchLevel":1},"zh":{"href":"/zh/api-reference/monitors/create","matchLevel":1},"it":{"href":"/it/api-reference/monitors/create","matchLevel":1},"ja":{"href":"/ja/api-reference/monitors/create","matchLevel":1}}},"lastModified":"2026-05-29T15:13:33.941Z","originalFileLocation":"api-reference/monitors/create.mdx","locale":"en"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Creates a monitor from a natural-language query. Provisions a shadow agent, generates a workflow spec, queues DAG planning, and schedules recurring runs. Configure delivery with notification.channels and/or webhook. Returns 202 with status provisioning, or stream progress with ?stream=1.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Olostep Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/olostep-58/_83ELNnJOV2rn47b/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/olostep-58/_83ELNnJOV2rn47b/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/olostep-58/_83ELNnJOV2rn47b/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/olostep-58/_83ELNnJOV2rn47b/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/olostep-58/_83ELNnJOV2rn47b/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/olostep-58/_83ELNnJOV2rn47b/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/olostep-58/_83ELNnJOV2rn47b/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/olostep-58/_83ELNnJOV2rn47b/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/olostep-58/_83ELNnJOV2rn47b/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Monitor - Olostep Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Creates a monitor from a natural-language query. Provisions a shadow agent, generates a workflow spec, queues DAG planning, and schedules recurring runs. Configure delivery with notification.channels and/or webhook. Returns 202 with status provisioning, or stream progress with ?stream=1.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Olostep Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.olostep.com/api-reference/monitors/create\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://olostep-58.mintlify.app/_mintlify/api/og/v2?division=Monitors\u0026amp;title=Create+Monitor\u0026amp;description=Creates+a+monitor+from+a+natural-language+query.+Provisions+a+shadow+agent%2C+generates+a+workflow+spec%2C+queues+DAG+planning%2C+and+schedules+recurring+runs.+Config\u0026amp;theme=b5e609b90b3258b879e86eb5\u0026amp;signature=4ea688c5947be1a690467ad5e4795878313fb44c8c051d2a04ba7c49c84d054e\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Create Monitor - Olostep Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Creates a monitor from a natural-language query. Provisions a shadow agent, generates a workflow spec, queues DAG planning, and schedules recurring runs. Configure delivery with notification.channels and/or webhook. Returns 202 with status provisioning, or stream progress with ?stream=1.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://olostep-58.mintlify.app/_mintlify/api/og/v2?division=Monitors\u0026amp;title=Create+Monitor\u0026amp;description=Creates+a+monitor+from+a+natural-language+query.+Provisions+a+shadow+agent%2C+generates+a+workflow+spec%2C+queues+DAG+planning%2C+and+schedules+recurring+runs.+Config\u0026amp;theme=b5e609b90b3258b879e86eb5\u0026amp;signature=4ea688c5947be1a690467ad5e4795878313fb44c8c051d2a04ba7c49c84d054e\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/olostep-58/_83ELNnJOV2rn47b/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Olostep Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9563FF\">\u003cmeta data-mint-head name=\"googlebot\" content=\"index, follow\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.olostep.com/api-reference/monitors/create\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/monitors/create.md\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"en\" href=\"https://docs.olostep.com/api-reference/monitors/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"de\" href=\"https://docs.olostep.com/de/api-reference/monitors/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"fr\" href=\"https://docs.olostep.com/fr/api-reference/monitors/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"es\" href=\"https://docs.olostep.com/es/api-reference/monitors/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"nl\" href=\"https://docs.olostep.com/nl/api-reference/monitors/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"zh\" href=\"https://docs.olostep.com/zh/api-reference/monitors/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"it\" href=\"https://docs.olostep.com/it/api-reference/monitors/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"ja\" href=\"https://docs.olostep.com/ja/api-reference/monitors/create\">\u003clink data-mint-head rel=\"alternate\" hreflang=\"x-default\" href=\"https://docs.olostep.com/api-reference/monitors/create\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.olostep.com/#organization\",\"name\":\"Olostep Docs\",\"url\":\"https://docs.olostep.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/olostep-58/294AdrknPYBl2RjK/logo/light.svg?fit=max\u0026auto=format\u0026n=294AdrknPYBl2RjK\u0026q=85\u0026s=fad5e5ee72a916722d9ad8279ee7186d\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.olostep.com#website\",\"name\":\"Olostep Docs\",\"url\":\"https://docs.olostep.com\",\"publisher\":{\"@id\":\"https://docs.olostep.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.olostep.com/api-reference/monitors/create#webpage\",\"url\":\"https://docs.olostep.com/api-reference/monitors/create\",\"name\":\"Create Monitor\",\"description\":\"Creates a monitor from a natural-language query. Provisions a shadow agent, generates a workflow spec, queues DAG planning, and schedules recurring runs. Configure delivery with notification.channels and/or webhook. Returns 202 with status provisioning, or stream progress with ?stream=1.\",\"dateModified\":\"2026-05-29T15:13:33.941Z\",\"isPartOf\":{\"@id\":\"https://docs.olostep.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.olostep.com/api-reference/monitors/create#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.olostep.com/api-reference/monitors/create#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Olostep Docs\",\"item\":\"https://docs.olostep.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Monitor\",\"item\":\"https://docs.olostep.com/api-reference/monitors/create\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.olostep.com/api-reference/monitors/create#apireference\",\"headline\":\"Create Monitor\",\"name\":\"Create Monitor\",\"description\":\"Creates a monitor from a natural-language query. Provisions a shadow agent, generates a workflow spec, queues DAG planning, and schedules recurring runs. Configure delivery with notification.channels and/or webhook. Returns 202 with status provisioning, or stream progress with ?stream=1.\",\"url\":\"https://docs.olostep.com/api-reference/monitors/create\",\"mainEntityOfPage\":{\"@id\":\"https://docs.olostep.com/api-reference/monitors/create#webpage\"},\"dateModified\":\"2026-05-29T15:13:33.941Z\",\"publisher\":{\"@id\":\"https://docs.olostep.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.olostep.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Olostep Docs\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Olostep Docs","nav":{"global":{"anchors":[{"anchor":"Playground","icon":"play","href":"https://www.olostep.com/playground"},{"anchor":"Join Community","icon":"slack","href":"https://olostep-users.slack.com/join/shared_invite/zt-2bfddyi8h-JzfjOgavg~98DJ1om1B5Lg#/shared-invite/email"},{"anchor":"Blog","icon":"newspaper","href":"https://www.olostep.com/blog"}]},"languages":[{"language":"en","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/get-started/welcome"}]},{"tab":"SDKs","pages":[{"title":"SDKs","href":"/sdks/overview"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli/overview"}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/examples/get-markdown-from-website"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/integrations/mcp-server"}]},{"tab":"API Reference","groups":[{"group":"Common","pages":[{"title":"Object-Oriented API","sidebarTitle":"Object-Oriented API","icon":"cube","href":"/api-reference/common/object-oriented"},{"title":"Metadata","sidebarTitle":"Metadata","icon":"tag","href":"/api-reference/common/metadata"},{"title":"Webhooks","icon":"webhook","href":"/api-reference/common/webhooks"}]},{"group":"Scrapes","pages":[{"title":"Create Scrape","openapi":"openapi/scrapes.json POST /v1/scrapes","href":"/api-reference/scrapes/create"},{"title":"Get Scrape","openapi":"openapi/scrapes.json GET /v1/scrapes/{scrape_id}","href":"/api-reference/scrapes/get"}]},{"group":"Batches","pages":[{"title":"Create Batch","openapi":"openapi/batches.json POST /v1/batches","href":"/api-reference/batches/create"},{"title":"Batch Info","openapi":"openapi/batches.json GET /v1/batches/{batch_id}","href":"/api-reference/batches/info"},{"title":"Update Batch","openapi":"openapi/batches.json PATCH /v1/batches/{batch_id}","href":"/api-reference/batches/update"},{"title":"Batch Items","openapi":"openapi/batches.json GET /v1/batches/{batch_id}/items","href":"/api-reference/batches/items"}]},{"group":"Crawls","pages":[{"title":"Create Crawl","openapi":"openapi/crawls.json POST /v1/crawls","href":"/api-reference/crawls/create"},{"title":"Crawl Info","openapi":"openapi/crawls.json GET /v1/crawls/{crawl_id}","href":"/api-reference/crawls/info"},{"title":"Crawl Pages","openapi":"openapi/crawls.json GET /v1/crawls/{crawl_id}/pages","href":"/api-reference/crawls/pages"}]},{"group":"Maps","pages":[{"title":"Create Map","openapi":"openapi/maps.json POST /v1/maps","href":"/api-reference/maps/create"},{"title":"Get Map","openapi":"openapi/maps.json GET /v1/maps/{map_id}","href":"/api-reference/maps/get"}]},{"group":"Answers","pages":[{"title":"Create Answer","openapi":"openapi/answers.json POST /v1/answers","href":"/api-reference/answers/create"},{"title":"Get Answer","openapi":"openapi/answers.json GET /v1/answers/{answer_id}","href":"/api-reference/answers/get"}]},{"group":"Search","pages":[{"title":"Create Search","openapi":"openapi/search.json POST /v1/searches","href":"/api-reference/searches/create"},{"title":"Get Search","openapi":"openapi/search.json GET /v1/searches/{search_id}","description":"Retrieve a previously completed search by its ID. Returns whatever was persisted at search time, including any scraped per-link content. Pure idempotent read — no re-scraping, no re-billing.","href":"/api-reference/searches/get"}]},{"group":"Monitors","pages":[{"title":"Create Monitor","openapi":"openapi/monitors.json POST /v1/monitors","href":"/api-reference/monitors/create"},{"title":"List Monitors","description":"Retrieves all monitors for your team. Returns active monitors by default and can include deleted monitors when requested.","openapi":"openapi/monitors.json GET /v1/monitors","href":"/api-reference/monitors/list"},{"title":"Get Monitor","openapi":"openapi/monitors.json GET /v1/monitors/{monitor_id}","href":"/api-reference/monitors/get"},{"title":"List Monitor Events","openapi":"openapi/monitors.json GET /v1/monitors/{monitor_id}/events","href":"/api-reference/monitors/events"},{"title":"Get Monitor Planning","openapi":"openapi/monitors.json GET /v1/monitors/{monitor_id}/planning","href":"/api-reference/monitors/planning"},{"title":"Get Monitor Run","openapi":"openapi/monitors.json GET /v1/monitors/{monitor_id}/runs/{run_id}","href":"/api-reference/monitors/run"},{"title":"Stream Monitor Agent Logs","openapi":"openapi/monitors.json GET /v1/monitors/{monitor_id}/agent-logs","href":"/api-reference/monitors/agent-logs"},{"title":"Update Monitor","openapi":"openapi/monitors.json POST /v1/monitors/{monitor_id}","href":"/api-reference/monitors/update"},{"title":"Pause Monitor","openapi":"openapi/monitors.json POST /v1/monitors/{monitor_id}/pause","href":"/api-reference/monitors/pause"},{"title":"Resume Monitor","openapi":"openapi/monitors.json POST /v1/monitors/{monitor_id}/resume","href":"/api-reference/monitors/resume"},{"title":"Delete Monitor","openapi":"openapi/monitors.json DELETE /v1/monitors/{monitor_id}","href":"/api-reference/monitors/delete"}]},{"group":"Files","pages":[{"title":"Create File Upload","openapi":"openapi/files.json POST /v1/files","href":"/api-reference/files/create"},{"title":"Complete File Upload","openapi":"openapi/files.json POST /v1/files/{file_id}/complete","href":"/api-reference/files/complete"},{"title":"Get File","openapi":"openapi/files.json GET /v1/files/{file_id}","href":"/api-reference/files/get"},{"title":"Get File Content","openapi":"openapi/files.json GET /v1/files/{file_id}/content","href":"/api-reference/files/content"},{"title":"List Files","openapi":"openapi/files.json GET /v1/files","href":"/api-reference/files/list"},{"title":"Delete File","openapi":"openapi/files.json DELETE /v1/files/{file_id}","href":"/api-reference/files/delete"}]},{"group":"Schedules","pages":[{"title":"Create Schedule","openapi":"openapi/schedules.json POST /v1/schedules","href":"/api-reference/schedules/create"},{"title":"List Schedules","openapi":"openapi/schedules.json GET /v1/schedules","href":"/api-reference/schedules/list"},{"title":"Get Schedule","openapi":"openapi/schedules.json GET /v1/schedules/{schedule_id}","href":"/api-reference/schedules/get"},{"title":"Delete Schedule","openapi":"openapi/schedules.json DELETE /v1/schedules/{schedule_id}","href":"/api-reference/schedules/delete"}]},{"group":"Retrieve","pages":[{"title":"Retrieve Content","openapi":"openapi/utility.json GET /v1/retrieve","href":"/api-reference/retrieve"}]},{"group":"Feedbacks","pages":[{"title":"Submit Feedback","openapi":"openapi/feedbacks.json POST /v1/feedbacks","href":"/api-reference/feedbacks/create"}]},{"group":"Balance \u0026 Billing","pages":[{"title":"Get credit info","openapi":"openapi/billing.json GET /user/credits/info","href":"/api-reference/billing/credits-info"},{"title":"Purchase top-up","openapi":"openapi/billing.json POST /user/purchase-topup","href":"/api-reference/billing/purchase-topup"}]}]},{"tab":"Internal","hidden":true,"pages":[{"title":"Internal","href":"/internal/airops-batches/overview"}]},{"tab":"Preview Features","hidden":true,"pages":[{"title":"Preview Features","href":"/internal/browser-session"}]},{"tab":"Developer Guides","hidden":true,"pages":[{"title":"Developer Guides","href":"/internal/detailed-geo"}]},{"tab":"Partner User Quick-Connect","hidden":true,"pages":[{"title":"Partner User Quick-Connect","href":"/internal/partner-user-quick-connect"}]},{"tab":"E-commerce","hidden":true,"pages":[{"title":"E-commerce","href":"/internal/ecommerce"}]},{"tab":"Parser Versioning","hidden":true,"pages":[{"title":"Parser Versioning","href":"/internal/parser-versioning"}]},{"tab":"Firecrawl Migration","hidden":true,"pages":[{"title":"Firecrawl Migration","href":"/internal/firecrawl-migration"}]}]},{"language":"de","pages":[{"title":"de","href":"/de/api-reference/monitors/create"}]},{"language":"fr","pages":[{"title":"fr","href":"/fr/api-reference/monitors/create"}]},{"language":"es","pages":[{"title":"es","href":"/es/api-reference/monitors/create"}]},{"language":"nl","pages":[{"title":"nl","href":"/nl/api-reference/monitors/create"}]},{"language":"zh","pages":[{"title":"zh","href":"/zh/api-reference/monitors/create"}]},{"language":"it","pages":[{"title":"it","href":"/it/api-reference/monitors/create"}]},{"language":"ja","pages":[{"title":"ja","href":"/ja/api-reference/monitors/create"}]}]},"basePath":"","title":"Create Monitor - Olostep Docs","buildId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","deploymentId":"dpl_DeHjVRGfFnhYQwHnfC2pjeXXv8h9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CS552b7R.js","utils-DDTCYAF2.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-De8ttokP.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DrwRDvAh.js","snippetPresets-DtAN0nWx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-D5rWArI6.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-O2i12wsz.js","shallow-DV8xABTt.js","getApiPlaygroundDisplay-DBZ0B5Jx.js","CodeSnippet-BVi0tPUX.js","CodeSnippets-CqASbIwY.js","Page-m07pfKpT.js","getPastedJson-DG9vsMS8.js","icon-CXzRSCr8.js","MethodPill-BdKVtEuX.js","DuplicateIcon-CZlmBrJI.js","createIcon-biFEUKPL.js","DynamicMarkdown-B54_zNBF.js","SectionHeading-DwwHK3Pt.js","axios-vUo_bRtp.js","Markdown-DfhCTwyA.js","clsx-xpJZXxdP.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BTZUMDnx.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-DqdKa2R4.js"]}