Python
from parallel import Parallel
client = Parallel()
page = client.monitor.list(limit=10)
for monitor in page.monitors:
print(monitor.monitor_id, monitor.status)import Parallel from "parallel-web";
const client = new Parallel();
const page = await client.monitor.list({ limit: 10 });
for (const monitor of page.monitors) {
console.log(monitor.monitor_id, monitor.status);
}curl --request GET \
--url https://api.parallel.ai/v1/monitors \
--header 'x-api-key: <api-key>'{
"monitors": [
{
"type": "event_stream",
"monitor_id": "<string>",
"status": "active",
"frequency": "1h",
"processor": "lite",
"created_at": "2025-01-15T10:30:00Z",
"settings": {
"query": "Extract recent news about AI",
"output_schema": {
"json_schema": {
"additionalProperties": false,
"properties": {
"gdp": {
"description": "GDP in USD for the year, formatted like '$3.1 trillion (2023)'",
"type": "string"
}
},
"required": [
"gdp"
],
"type": "object"
},
"type": "json"
},
"include_backfill": true,
"advanced_settings": {
"source_policy": {
"include_domains": [
"wikipedia.org",
"docs.python.org/3",
".edu"
]
},
"location": "us"
}
},
"webhook": {
"url": "https://example.com/webhook",
"event_types": [
"monitor.event.detected"
]
},
"metadata": {
"slack_thread_id": "1234567890.123456",
"user_id": "U123ABC"
},
"last_run_at": "2025-01-15T10:30:00Z",
"output": {
"latest_snapshot": {
"basis": [
{
"field": "<string>",
"reasoning": "<string>",
"citations": [],
"confidence": "low"
}
],
"type": "text",
"content": "<string>",
"mcp_tool_calls": [
{
"tool_call_id": "<string>",
"server_name": "<string>",
"tool_name": "<string>",
"arguments": "<string>",
"content": "<string>",
"error": "<string>"
}
],
"beta_fields": {}
}
}
}
],
"next_cursor": "<string>"
}{
"type": "error",
"error": {
"ref_id": "fcb2b4f3-c75e-4186-87bc-caa1a8381331",
"message": "Unauthorized: invalid or missing credentials"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Monitor
List Monitors
List monitors ordered by creation time, newest first.
Monitors are sorted by created_at descending. limit defaults to 100.
Use next_cursor from the response and pass it as cursor to fetch the
next page. Pagination ends when next_cursor is absent.
By default only active monitors are returned. Pass status=cancelled
or both values to include cancelled monitors.
The legacy Monitor API (/v1alpha/monitors endpoints) is documented under
the Monitor (Alpha) tag.
GET
/
v1
/
monitors
Python
from parallel import Parallel
client = Parallel()
page = client.monitor.list(limit=10)
for monitor in page.monitors:
print(monitor.monitor_id, monitor.status)import Parallel from "parallel-web";
const client = new Parallel();
const page = await client.monitor.list({ limit: 10 });
for (const monitor of page.monitors) {
console.log(monitor.monitor_id, monitor.status);
}curl --request GET \
--url https://api.parallel.ai/v1/monitors \
--header 'x-api-key: <api-key>'{
"monitors": [
{
"type": "event_stream",
"monitor_id": "<string>",
"status": "active",
"frequency": "1h",
"processor": "lite",
"created_at": "2025-01-15T10:30:00Z",
"settings": {
"query": "Extract recent news about AI",
"output_schema": {
"json_schema": {
"additionalProperties": false,
"properties": {
"gdp": {
"description": "GDP in USD for the year, formatted like '$3.1 trillion (2023)'",
"type": "string"
}
},
"required": [
"gdp"
],
"type": "object"
},
"type": "json"
},
"include_backfill": true,
"advanced_settings": {
"source_policy": {
"include_domains": [
"wikipedia.org",
"docs.python.org/3",
".edu"
]
},
"location": "us"
}
},
"webhook": {
"url": "https://example.com/webhook",
"event_types": [
"monitor.event.detected"
]
},
"metadata": {
"slack_thread_id": "1234567890.123456",
"user_id": "U123ABC"
},
"last_run_at": "2025-01-15T10:30:00Z",
"output": {
"latest_snapshot": {
"basis": [
{
"field": "<string>",
"reasoning": "<string>",
"citations": [],
"confidence": "low"
}
],
"type": "text",
"content": "<string>",
"mcp_tool_calls": [
{
"tool_call_id": "<string>",
"server_name": "<string>",
"tool_name": "<string>",
"arguments": "<string>",
"content": "<string>",
"error": "<string>"
}
],
"beta_fields": {}
}
}
}
],
"next_cursor": "<string>"
}{
"type": "error",
"error": {
"ref_id": "fcb2b4f3-c75e-4186-87bc-caa1a8381331",
"message": "Unauthorized: invalid or missing credentials"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}