Create Monitor

Python

from parallel import Parallel

client = Parallel()

monitor = client.monitor.create(
    type="event_stream",
    frequency="1d",
    settings={"query": "Extract recent news about AI"},
)
print(monitor.monitor_id)

import Parallel from "parallel-web";

const client = new Parallel();

const monitor = await client.monitor.create({
    type: 'event_stream',
    frequency: '1d',
    settings: { query: 'Extract recent news about AI' },
});
console.log(monitor.monitor_id);

HttpResponse<String> response = Unirest.post("https://api.parallel.ai/v1/monitors")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"frequency\": \"<string>\",\n  \"settings\": {\n    \"query\": \"<string>\",\n    \"output_schema\": {\n      \"json_schema\": {},\n      \"type\": \"json\"\n    },\n    \"include_backfill\": true,\n    \"advanced_settings\": {\n      \"source_policy\": {\n        \"exclude_domains\": [\n          \"reddit.com\",\n          \"x.com\",\n          \".ai\"\n        ],\n        \"include_domains\": [\n          \"wikipedia.org\",\n          \"usa.gov\",\n          \".edu\"\n        ]\n      },\n      \"location\": \"us\"\n    }\n  }\n}")
  .asString();

curl --request POST \
  --url https://api.parallel.ai/v1/monitors \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "frequency": "<string>",
  "settings": {
    "query": "<string>",
    "output_schema": {
      "json_schema": {},
      "type": "json"
    },
    "include_backfill": true,
    "advanced_settings": {
      "source_policy": {
        "exclude_domains": [
          "reddit.com",
          "x.com",
          ".ai"
        ],
        "include_domains": [
          "wikipedia.org",
          "usa.gov",
          ".edu"
        ]
      },
      "location": "us"
    }
  }
}
'

{
  "monitor_id": "<string>",
  "frequency": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "settings": {
    "query": "<string>",
    "output_schema": {
      "json_schema": {},
      "type": "json"
    },
    "include_backfill": true,
    "advanced_settings": {
      "source_policy": {
        "exclude_domains": [
          "reddit.com",
          "x.com",
          ".ai"
        ],
        "include_domains": [
          "wikipedia.org",
          "usa.gov",
          ".edu"
        ]
      },
      "location": "us"
    }
  },
  "webhook": {
    "url": "<string>",
    "event_types": []
  },
  "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": "<string>",
      "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": "Unprocessable content: request validation error"
  }
}

POST

monitors

Python

from parallel import Parallel

client = Parallel()

monitor = client.monitor.create(
    type="event_stream",
    frequency="1d",
    settings={"query": "Extract recent news about AI"},
)
print(monitor.monitor_id)

import Parallel from "parallel-web";

const client = new Parallel();

const monitor = await client.monitor.create({
    type: 'event_stream',
    frequency: '1d',
    settings: { query: 'Extract recent news about AI' },
});
console.log(monitor.monitor_id);

HttpResponse<String> response = Unirest.post("https://api.parallel.ai/v1/monitors")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"frequency\": \"<string>\",\n  \"settings\": {\n    \"query\": \"<string>\",\n    \"output_schema\": {\n      \"json_schema\": {},\n      \"type\": \"json\"\n    },\n    \"include_backfill\": true,\n    \"advanced_settings\": {\n      \"source_policy\": {\n        \"exclude_domains\": [\n          \"reddit.com\",\n          \"x.com\",\n          \".ai\"\n        ],\n        \"include_domains\": [\n          \"wikipedia.org\",\n          \"usa.gov\",\n          \".edu\"\n        ]\n      },\n      \"location\": \"us\"\n    }\n  }\n}")
  .asString();

curl --request POST \
  --url https://api.parallel.ai/v1/monitors \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "frequency": "<string>",
  "settings": {
    "query": "<string>",
    "output_schema": {
      "json_schema": {},
      "type": "json"
    },
    "include_backfill": true,
    "advanced_settings": {
      "source_policy": {
        "exclude_domains": [
          "reddit.com",
          "x.com",
          ".ai"
        ],
        "include_domains": [
          "wikipedia.org",
          "usa.gov",
          ".edu"
        ]
      },
      "location": "us"
    }
  }
}
'

{
  "monitor_id": "<string>",
  "frequency": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "settings": {
    "query": "<string>",
    "output_schema": {
      "json_schema": {},
      "type": "json"
    },
    "include_backfill": true,
    "advanced_settings": {
      "source_policy": {
        "exclude_domains": [
          "reddit.com",
          "x.com",
          ".ai"
        ],
        "include_domains": [
          "wikipedia.org",
          "usa.gov",
          ".edu"
        ]
      },
      "location": "us"
    }
  },
  "webhook": {
    "url": "<string>",
    "event_types": []
  },
  "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": "<string>",
      "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": "Unprocessable content: request validation error"
  }
}

Authorizations

x-api-key

string

header

required

Body

application/json

Request body to create a monitor.

The type field at the root determines the expected shape of settings: event_stream requires MonitorEventStreamSettings, and snapshot requires MonitorSnapshotSettings.

type

enum<string>

required

Type of monitor to create. event_stream monitors a search query for material changes; snapshot monitors a specific task run's output. Determines the expected shape of settings.

Available options:

event_stream,

snapshot

Examples:

"event_stream"

"snapshot"

frequency

string

required

Frequency of the monitor. Format: '' where unit is 'h' (hours), 'd' (days), or 'w' (weeks). Must be between 1h and 30d (inclusive).

Examples:

"1h"

"12h"

"1d"

"7d"

"30d"

settings

MonitorEventStreamSettings · object

required

Type-specific settings for an event_stream monitor.

MonitorEventStreamSettings
MonitorSnapshotSettings

Show child attributes

processor

enum<string>

default:lite

Processor to use for the monitor. lite is faster and cheaper; base performs more thorough analysis at higher cost and latency. Defaults to lite.

Available options:

lite,

base

webhook

MonitorWebhook · object | null

Webhook to receive notifications about the monitor's execution.

Show child attributes

metadata

Metadata · object | null

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

Example:

{
  "slack_thread_id": "1234567890.123456",
  "user_id": "U123ABC"
}

Response

Monitor created 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.

type

enum<string>

required

The type of monitor.

Available options:

event_stream,

snapshot

Examples:

"event_stream"

"snapshot"

monitor_id

string

required

ID of the monitor.

status

enum<string>

required

Status of the monitor.

Available options:

active,

cancelled

Examples:

"active"

"cancelled"

frequency

string

required

Frequency of the monitor. Format: '' where unit is 'h' (hours), 'd' (days), or 'w' (weeks). Must be between 1h and 30d (inclusive).

Examples:

"1h"

"12h"

"1d"

"7d"

"30d"

processor

enum<string>

required

Processor to use for the monitor. lite is faster and cheaper; base performs more thorough analysis at higher cost and latency. Defaults to lite.

Available options:

lite,

base

Examples:

"lite"

"base"

created_at

string<date-time>

required

Timestamp of the creation of the monitor, as an RFC 3339 string.

Example:

"2025-01-15T10:30:00Z"

settings

MonitorEventStreamResponseSettings · object

required

Type-specific response fields for an event_stream monitor.

MonitorEventStreamResponseSettings
MonitorSnapshotResponseSettings

Show child attributes

webhook

MonitorWebhook · object | null

Webhook configuration for the monitor.

Show child attributes

metadata

Metadata · object | null

Show child attributes

Example:

{
  "slack_thread_id": "1234567890.123456",
  "user_id": "U123ABC"
}

last_run_at

string | null

Timestamp of the last run for the monitor, as an RFC 3339 string.

Example:

"2025-01-15T10:30:00Z"

output

MonitorSnapshotOutput · object | null

Runtime output state. Present only for snapshot monitors; null for event_stream monitors.

Show child attributes

List Monitors Retrieve Monitor

⌘I

Search

Extract

Tasks

FindAll

Monitor

Chat API (Beta)

Authorizations

Body

Response