from parallel import Parallel
client = Parallel()
monitor = client.monitor.retrieve("monitor_id")
print(monitor.status)import Parallel from "parallel-web";
const client = new Parallel();
const monitor = await client.monitor.retrieve('monitor_id');
console.log(monitor.status);curl --request GET \
--url https://api.parallel.ai/v1/monitors/{monitor_id} \
--header 'x-api-key: <api-key>'{
"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": {}
}
}
}{
"type": "error",
"error": {
"ref_id": "fcb2b4f3-c75e-4186-87bc-caa1a8381331",
"message": "Unauthorized: invalid or missing credentials"
}
}{
"type": "error",
"error": {
"ref_id": "fcb2b4f3-c75e-4186-87bc-caa1a8381331",
"message": "Monitor not found"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Retrieve Monitor
Retrieve a monitor.
Retrieves a specific monitor by monitor_id. Returns the monitor
configuration including status, frequency, query, and webhook settings.
from parallel import Parallel
client = Parallel()
monitor = client.monitor.retrieve("monitor_id")
print(monitor.status)import Parallel from "parallel-web";
const client = new Parallel();
const monitor = await client.monitor.retrieve('monitor_id');
console.log(monitor.status);curl --request GET \
--url https://api.parallel.ai/v1/monitors/{monitor_id} \
--header 'x-api-key: <api-key>'{
"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": {}
}
}
}{
"type": "error",
"error": {
"ref_id": "fcb2b4f3-c75e-4186-87bc-caa1a8381331",
"message": "Unauthorized: invalid or missing credentials"
}
}{
"type": "error",
"error": {
"ref_id": "fcb2b4f3-c75e-4186-87bc-caa1a8381331",
"message": "Monitor not found"
}
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}Response
Monitor retrieved successfully.
Response object for a monitor.
The type field at the root determines the concrete shape of settings:
event_stream uses MonitorEventStreamResponseSettings, and snapshot
uses MonitorSnapshotResponseSettings. Snapshot monitors also carry an
output field (MonitorSnapshotOutput) with the latest computed state.
Processor to use for the monitor. lite is the cheapest; base performs more thorough analysis for higher-quality results at higher cost; core performs the most thorough analysis for the highest-quality results at the highest cost. Defaults to lite.
lite, base, core "lite"
"base"
"core"
User-provided metadata stored with the monitor and echoed back in webhook notifications and GET responses, so you can map events to objects in your application. Keys: max 16 chars; values: max 512 chars.
Show child attributes
Show child attributes
{
"slack_thread_id": "1234567890.123456",
"user_id": "U123ABC"
}