Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.parallel.ai/llms.txt

Use this file to discover all available pages before exploring further.

For AI agents: a documentation index is available at https://docs.parallel.ai/llms.txt. The full text of all docs is at https://docs.parallel.ai/llms-full.txt. You may also fetch any page as Markdown by appending .md to its URL or sending Accept: text/markdown.
Monitors produce a stream of events on each execution. Every event object has an event_type field that discriminates the variant:
event_typeDescription
event_streamA new material change detected by an event_stream monitor. See Event Stream Quickstart.
snapshotA change to the monitored task output detected by a snapshot monitor. See Snapshot Quickstart.
completionExecution completed with no new detections.
errorExecution failed.
A run maps to exactly one outcome. Runs with detected events do not also emit a completion event.

Event Stream Events (event_type: "event_stream")

Emitted when an event_stream monitor detects a new material change. Each event is an append-only entry in the monitor’s log.
FieldTypeDescription
event_idstringStable identifier. Safe to use for client-side deduplication across pagination and retries.
event_group_idstringID of the event group that owns this event.
event_datestring | nullDate the event was produced (ISO 8601: YYYY-MM-DD or partial).
event_type"event_stream"Discriminant.
outputobjectText or JSON output describing the detected change. Includes type, content, and basis.

Snapshot Events (event_type: "snapshot")

Emitted when a snapshot monitor detects that the monitored task output has changed. Contains both what changed and what it was before.
FieldTypeDescription
event_idstringStable identifier. Safe to use for client-side deduplication.
event_group_idstringID of the event group that owns this event.
event_datestring | nullDate the event was produced (ISO 8601).
event_type"snapshot"Discriminant.
changed_outputobjectPartial output containing only the fields that changed, each with basis (reasoning and citations).
previous_outputobjectFull output from the prior run, for comparison.

Event Basis

Every detected event (event_stream and snapshot) includes a basis field in its output with citations, reasoning, and a confidence level—the same transparency framework used in Task API outputs. See Research Basis for the full schema.

Accessing Events

Events can be received via webhooks (recommended) or retrieved via the API. Lowest latency, push-based delivery. Subscribe to monitor.event.detected, monitor.execution.completed, and monitor.execution.failed. See Webhooks for setup details.

API

List all events for a monitor, newest first:
curl --request GET \
  --url "https://api.parallel.ai/v1/monitors/${MONITOR_ID}/events" \
  --header "x-api-key: $PARALLEL_API_KEY"
Returns up to the ~300 most recent executions. Use next_cursor for pagination. Pass include_completions=true to include no-change runs. Filter by execution using the event_group_id query parameter:
curl --request GET \
  --url "https://api.parallel.ai/v1/monitors/${MONITOR_ID}/events?event_group_id=${EVENT_GROUP_ID}" \
  --header "x-api-key: $PARALLEL_API_KEY"
Use the event_group_id from the webhook payload directly as the query parameter to fetch all events from a specific execution.