> ## Documentation Index > Fetch the complete documentation index at: https://aisa.one/docs/llms.txt > Use this file to discover all available pages before exploring further. # Retrieve Monitor > Retrieve a monitor. Retrieves a specific monitor by monitor_id. Returns the monitor configuration including status, frequency, query, and webhook settings. ## OpenAPI ````yaml openapi/parallel.ai.json GET /apis/v1/parallel/monitors/{monitor_id} openapi: 3.1.0 info: description: '' title: Parallel.ai version: '1' x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-configured-paths: - /apis/v1/parallel/chat/completions - /apis/v1/parallel/extract - /apis/v1/parallel/findall/ingest - /apis/v1/parallel/findall/runs/{findall_id} - /apis/v1/parallel/findall/runs/{findall_id}/cancel - /apis/v1/parallel/findall/runs/{findall_id}/events - /apis/v1/parallel/findall/runs/{findall_id}/result - /apis/v1/parallel/findall/runs/{findall_id}/schema - /apis/v1/parallel/monitors/{monitor_id} - /apis/v1/parallel/monitors/{monitor_id}/cancel - /apis/v1/parallel/monitors/{monitor_id}/events - /apis/v1/parallel/monitors/{monitor_id}/update - /apis/v1/parallel/tasks/groups - /apis/v1/parallel/tasks/groups/{taskgroup_id} - /apis/v1/parallel/tasks/groups/{taskgroup_id}/events - /apis/v1/parallel/tasks/groups/{taskgroup_id}/runs/{run_id} - /apis/v1/parallel/tasks/runs/{run_id} - /apis/v1/parallel/tasks/runs/{run_id}/events - /apis/v1/parallel/tasks/runs/{run_id}/input - /apis/v1/parallel/tasks/runs/{run_id}/result - /apis/v1/parallel/v1beta/tasks/runs/{run_id}/events x-aisa-document: facts_hash: 7d3bf2025708131927d3136de215ba314114253046b35f239876910b2481cbd9 generator_version: '2' protocol_version: '1' schema_version: '1' composer_version: '13' response_pending: [] document_hash: sha256:dae9e982424f710c06d9af023168dd26ed96bf5e5b5232e0728c01867d2da7dc x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: parallel.ai x-aisa-catalogs: parallel.ai: title: Parallel.ai description: '' x-aisa-document: facts_hash: 7d3bf2025708131927d3136de215ba314114253046b35f239876910b2481cbd9 generator_version: '2' protocol_version: '1' schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/parallel/monitors/{monitor_id}: get: tags: - default summary: Retrieve Monitor description: >- Retrieve a monitor. Retrieves a specific monitor by monitor_id. Returns the monitor configuration including status, frequency, query, and webhook settings. operationId: any_parallel_ai_apis_v1_parallel_monitors_monitor_id parameters: - name: monitor_id in: path required: true schema: type: string title: Monitor Id responses: '200': description: Monitor retrieved successfully. content: application/json: schema: $ref: '#/components/schemas/ResponseB67C75A8Feba_MonitorResponse' default: content: application/json: schema: {} description: >- Error response; upstream passthrough responses may use provider formats components: schemas: ResponseB67C75A8Feba_MonitorResponse: properties: type: type: string enum: - event_stream - snapshot title: Type description: The type of monitor. examples: - event_stream - snapshot monitor_id: type: string title: Monitor ID description: ID of the monitor. status: type: string enum: - active - cancelled title: Status description: Status of the monitor. examples: - active - cancelled frequency: type: string title: Frequency description: >- 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: type: string enum: - lite - base title: Processor description: >- Processor to use for the monitor. `lite` is faster and cheaper; `base` performs more thorough analysis at higher cost and latency. Defaults to `lite`. examples: - lite - base webhook: anyOf: - $ref: '#/components/schemas/ResponseB67C75A8Feba_MonitorWebhook' - type: 'null' description: Webhook configuration for the monitor. metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' title: Metadata description: >- 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. examples: - slack_thread_id: '1234567890.123456' user_id: U123ABC created_at: type: string format: date-time title: Created At description: Timestamp of the creation of the monitor, as an RFC 3339 string. examples: - '2025-01-15T10:30:00Z' last_run_at: anyOf: - type: string - type: 'null' title: Last Run At description: Timestamp of the last run for the monitor, as an RFC 3339 string. examples: - '2025-01-15T10:30:00Z' settings: anyOf: - $ref: >- #/components/schemas/ResponseB67C75A8Feba_MonitorEventStreamResponseSettings - $ref: >- #/components/schemas/ResponseB67C75A8Feba_MonitorSnapshotResponseSettings title: Settings description: >- Type-specific configuration. Shape is determined by `type`: `MonitorEventStreamResponseSettings` for `event_stream`, `MonitorSnapshotResponseSettings` for `snapshot`. output: anyOf: - $ref: '#/components/schemas/ResponseB67C75A8Feba_MonitorSnapshotOutput' - type: 'null' description: >- Runtime output state. Present only for `snapshot` monitors; `null` for `event_stream` monitors. type: object required: - type - monitor_id - status - frequency - processor - created_at - settings title: MonitorResponse description: >- 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. ResponseB67C75A8Feba_MonitorWebhook: properties: url: type: string title: Url description: URL for the webhook. examples: - https://example.com/webhook event_types: items: type: string enum: - monitor.event.detected - monitor.execution.completed - monitor.execution.failed type: array title: Event Types description: Event types to send the webhook notifications for. type: object required: - url title: MonitorWebhook description: Webhook configuration for a monitor. ResponseB67C75A8Feba_MonitorEventStreamResponseSettings: properties: query: type: string title: Query description: The search query being monitored. examples: - Extract recent news about AI output_schema: anyOf: - $ref: '#/components/schemas/ResponseB67C75A8Feba_JsonSchema' - type: 'null' description: >- JSON schema that constrains and structures the event output. When set, events are returned as JSON objects matching this schema. include_backfill: anyOf: - type: boolean - type: 'null' title: Include Backfill description: >- If true, the first execution returns a sample of recent historical events matching the query (preview only — not exhaustive). If false or omitted, only events from the monitor's creation date onward are returned. Subsequent executions are always incremental. advanced_settings: anyOf: - $ref: >- #/components/schemas/ResponseB67C75A8Feba_AdvancedMonitorSettings - type: 'null' description: Advanced monitor configuration. type: object required: - query title: MonitorEventStreamResponseSettings description: Type-specific response fields for an `event_stream` monitor. ResponseB67C75A8Feba_MonitorSnapshotResponseSettings: properties: task_run_id: type: string title: Task Run Id description: ID of the task run used as the monitoring baseline. query: type: string title: Query description: >- The original task input from the baseline task run that this monitor tracks. examples: - Extract recent news about AI output_schema: anyOf: - $ref: '#/components/schemas/ResponseB67C75A8Feba_JsonSchema' - type: 'null' description: >- JSON schema derived from the baseline task run that constrains and structures the event output. type: object required: - task_run_id - query title: MonitorSnapshotResponseSettings description: Configuration settings for a `snapshot` monitor. ResponseB67C75A8Feba_MonitorSnapshotOutput: properties: latest_snapshot: anyOf: - oneOf: - $ref: '#/components/schemas/ResponseB67C75A8Feba_TaskRunTextOutput' - $ref: '#/components/schemas/ResponseB67C75A8Feba_TaskRunJsonOutput' discriminator: propertyName: type mapping: json: '#/components/schemas/ResponseB67C75A8Feba_TaskRunJsonOutput' text: '#/components/schemas/ResponseB67C75A8Feba_TaskRunTextOutput' - type: 'null' title: Latest Snapshot description: >- Task run output from the most recent completed execution of this snapshot monitor — same structure as the output of the original task run the monitor was created from. `null` until the first run completes. type: object title: MonitorSnapshotOutput description: Runtime output state for a `snapshot` monitor. ResponseB67C75A8Feba_JsonSchema: properties: json_schema: additionalProperties: true type: object title: Json Schema description: A JSON Schema object. Only a subset of JSON Schema is supported. examples: - additionalProperties: false properties: gdp: description: >- GDP in USD for the year, formatted like '$3.1 trillion (2023)' type: string required: - gdp type: object type: type: string const: json title: Type description: The type of schema being defined. Always `json`. default: json type: object required: - json_schema title: JsonSchema description: JSON schema for a task input or output. ResponseB67C75A8Feba_AdvancedMonitorSettings: properties: source_policy: anyOf: - $ref: '#/components/schemas/ResponseB67C75A8Feba_SourcePolicy' - type: 'null' description: >- Source policy governing included and excluded domains or domain/path prefixes for monitor search results. examples: - include_domains: - wikipedia.org - docs.python.org/3 - .edu - exclude_domains: - reddit.com - youtube.com/shorts - .ai location: anyOf: - type: string - type: 'null' title: Location description: ISO 3166-1 alpha-2 country code for geo-targeted monitor results. examples: - us - gb - de - jp type: object title: AdvancedMonitorSettings description: Advanced monitor configuration. ResponseB67C75A8Feba_TaskRunTextOutput: properties: basis: items: $ref: '#/components/schemas/ResponseB67C75A8Feba_FieldBasis' type: array title: Basis description: Basis for the output. The basis has a single field 'output'. type: type: string const: text title: Type description: >- The type of output being returned, as determined by the output schema of the task spec. mcp_tool_calls: anyOf: - items: $ref: '#/components/schemas/ResponseB67C75A8Feba_McpToolCall' type: array - type: 'null' title: Mcp Tool Calls description: MCP tool calls made by the task. beta_fields: anyOf: - additionalProperties: true type: object - type: 'null' title: Beta Fields description: >- Deprecated. mcp-server-2025-07-17 is now included directly in the output (e.g. mcp_tool_calls). deprecated: true content: type: string title: Content description: Text output from the task. type: object required: - basis - type - content title: TaskRunTextOutput description: Output from a task that returns text. ResponseB67C75A8Feba_TaskRunJsonOutput: properties: basis: items: $ref: '#/components/schemas/ResponseB67C75A8Feba_FieldBasis' type: array title: Basis description: >- Basis for each top-level field in the JSON output. List fields also include per-element entries with dot-delimited indexes, such as `key_executives.0`. type: type: string const: json title: Type description: >- The type of output being returned, as determined by the output schema of the task spec. mcp_tool_calls: anyOf: - items: $ref: '#/components/schemas/ResponseB67C75A8Feba_McpToolCall' type: array - type: 'null' title: Mcp Tool Calls description: MCP tool calls made by the task. beta_fields: anyOf: - additionalProperties: true type: object - type: 'null' title: Beta Fields description: >- Deprecated. mcp-server-2025-07-17 is now included directly in the output (e.g. mcp_tool_calls). deprecated: true content: additionalProperties: true type: object title: Content description: >- Output from the task as a native JSON object, as determined by the output schema of the task spec. output_schema: anyOf: - additionalProperties: true type: object - type: 'null' title: Output Schema description: >- Output schema for the Task Run. Populated only if the task was executed with an auto schema. type: object required: - basis - type - content title: TaskRunJsonOutput description: Output from a task that returns JSON. ResponseB67C75A8Feba_SourcePolicy: properties: include_domains: items: type: string type: array title: Include Domains description: >- List of domains or domain/path prefixes to restrict results to. If specified, only matching sources will be included and exclude_domains will be ignored. Accepts plain domains (e.g., wikipedia.org), domain/path prefixes (e.g., docs.python.org/3), or bare domain extensions (e.g., .gov, .edu, .co.uk). The combined number of entries in include_domains and exclude_domains cannot exceed 200. examples: - - wikipedia.org - docs.python.org/3 - .edu exclude_domains: items: type: string type: array title: Exclude Domains description: >- List of domains or domain/path prefixes to exclude from results. Applied only when include_domains is empty. If specified, matching sources will be excluded. Accepts plain domains (e.g., reddit.com), domain/path prefixes (e.g., youtube.com/shorts), or bare domain extensions (e.g., .gov, .edu, .co.uk). The combined number of entries in include_domains and exclude_domains cannot exceed 200. examples: - - reddit.com - youtube.com/shorts - .ai after_date: anyOf: - type: string format: date - type: 'null' title: After Date description: >- Optional start date for filtering search results. Results will be limited to content published on or after this date. Provided as an RFC 3339 date string (YYYY-MM-DD). examples: - '2024-01-01' type: object title: SourcePolicy description: >- Source policy for web search results. Plain domains match that domain and its subdomains. Domain/path entries use case-sensitive path matching at segment boundaries; trailing slashes are ignored, dot segments are normalized, and other percent-encoded path spelling is preserved. Entries omit schemes, ports, query strings, and fragments. When include_domains is non-empty, it defines the complete allowlist and exclude_domains is ignored. ResponseB67C75A8Feba_FieldBasis: description: Citations and reasoning supporting one field of a task output. properties: field: description: Name of the output field. title: Field type: string citations: default: [] description: List of citations supporting the output field. items: $ref: '#/components/schemas/ResponseB67C75A8Feba_Citation' title: Citations type: array reasoning: description: Reasoning for the output field. title: Reasoning type: string confidence: anyOf: - type: string - type: 'null' default: null description: >- Confidence level for the output field. Only certain processors provide confidence levels. examples: - low - medium - high title: Confidence required: - field - reasoning title: FieldBasis type: object ResponseB67C75A8Feba_McpToolCall: properties: tool_call_id: type: string title: Tool Call ID description: Identifier for the tool call. server_name: type: string title: Server Name description: Name of the MCP server. tool_name: type: string title: Tool Name description: Name of the tool being called. arguments: type: string title: Arguments description: Arguments used to call the MCP tool. content: anyOf: - type: string - type: 'null' title: Content description: Output received from the tool call, if successful. error: anyOf: - type: string - type: 'null' title: Error description: Error message if the tool call failed. type: object required: - tool_call_id - server_name - tool_name - arguments title: McpToolCall description: Result of an MCP tool call. ResponseB67C75A8Feba_Citation: description: A citation for a task output. properties: title: anyOf: - type: string - type: 'null' default: null description: Title of the citation. title: Title url: description: URL of the citation. title: Url type: string excerpts: anyOf: - items: type: string type: array - type: 'null' default: null description: >- Excerpts from the citation supporting the output. Only certain processors provide excerpts. title: Excerpts required: - url title: Citation type: object securitySchemes: bearerAuth: scheme: bearer type: http ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.