curl --request POST \
--url https://api.octen.ai/monitors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "page",
"page": {
"urls": [
"https://shop.example.com/products/widget-pro"
],
"output_schema": [
{
"field_name": "price",
"field_type": "number",
"field_desc": "Current price in USD"
}
]
},
"condition": "price drops more than 10%",
"schedule": {
"interval": "1h"
},
"webhook": {
"url": "https://example.com/hooks/octen"
}
}
'{
"code": 0,
"msg": "success",
"request_id": "req_abc123def456",
"data": {
"monitor_id": "mon_123",
"name": "shop.example.com/products/widget-pro",
"type": "page",
"page": {
"urls": [
"https://shop.example.com/products/widget-pro"
],
"output_schema": [
{
"field_name": "price",
"field_type": "number",
"field_desc": "Current price in USD"
}
]
},
"condition": "price drops more than 10%",
"schedule": {
"interval": "1h"
},
"webhook": {
"url": "https://example.com/hooks/octen",
"secret": "octen_whsec_..."
},
"status": "active",
"next_run_at": "2026-11-16T09:22:10Z",
"last_notified_at": null,
"created_at": "2026-11-16T08:22:10Z",
"notifications_7d": 0,
"first_run_id": "run_788"
}
}{
"code": 400,
"msg": "Missing required field: type",
"request_id": "req_abc123def456"
}{
"code": 401,
"msg": "Invalid API Key",
"request_id": "req_abc123def456"
}{
"code": 403,
"msg": "Insufficient balance in account",
"request_id": "req_abc123def456"
}{
"code": 429,
"msg": "Exceeding the rate limit",
"request_id": "req_abc123def456"
}{
"code": 500,
"msg": "Internal error",
"request_id": "req_abc123def456"
}Monitor
Create Monitor API Reference
Creates a monitor that watches a topic or up to 10 pages on a schedule. The first run starts right away and records a baseline. Each account can have up to 30 monitors, not counting deleted ones.
POST
/
monitors
curl --request POST \
--url https://api.octen.ai/monitors \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"type": "page",
"page": {
"urls": [
"https://shop.example.com/products/widget-pro"
],
"output_schema": [
{
"field_name": "price",
"field_type": "number",
"field_desc": "Current price in USD"
}
]
},
"condition": "price drops more than 10%",
"schedule": {
"interval": "1h"
},
"webhook": {
"url": "https://example.com/hooks/octen"
}
}
'{
"code": 0,
"msg": "success",
"request_id": "req_abc123def456",
"data": {
"monitor_id": "mon_123",
"name": "shop.example.com/products/widget-pro",
"type": "page",
"page": {
"urls": [
"https://shop.example.com/products/widget-pro"
],
"output_schema": [
{
"field_name": "price",
"field_type": "number",
"field_desc": "Current price in USD"
}
]
},
"condition": "price drops more than 10%",
"schedule": {
"interval": "1h"
},
"webhook": {
"url": "https://example.com/hooks/octen",
"secret": "octen_whsec_..."
},
"status": "active",
"next_run_at": "2026-11-16T09:22:10Z",
"last_notified_at": null,
"created_at": "2026-11-16T08:22:10Z",
"notifications_7d": 0,
"first_run_id": "run_788"
}
}{
"code": 400,
"msg": "Missing required field: type",
"request_id": "req_abc123def456"
}{
"code": 401,
"msg": "Invalid API Key",
"request_id": "req_abc123def456"
}{
"code": 403,
"msg": "Insufficient balance in account",
"request_id": "req_abc123def456"
}{
"code": 429,
"msg": "Exceeding the rate limit",
"request_id": "req_abc123def456"
}{
"code": 500,
"msg": "Internal error",
"request_id": "req_abc123def456"
}Authorizations
bearerAuthapiKeyAuth
Body
application/json
Request body for the Create Monitor API.
When to notify, in natural language, such as price drops more than 10%. An empty string or null means no condition.
Without a condition, the first run notifies once with change_status set to baseline. After that, a topic monitor notifies for each new relevant result; a page monitor notifies when any output_schema field changes or, without output_schema, when a model judges the page change meaningful.
Maximum string length:
1000Was this page helpful?