> ## 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. > ## Agent Instructions > - Base URLs: models `https://api.aisa.one/v1` (Gemini GenerateContent: `https://api.aisa.one/v1beta`); data APIs `https://api.aisa.one/apis/v1`. The `servers` of each operation in https://aisa.one/openapi.yaml is authoritative. > - Auth: `Authorization: Bearer $AISA_API_KEY`. Never print, log, or commit the key. > - MCP (preferred for agents): `https://mcp.aisa.one/mcp`, signed in with OAuth, so there is no key to paste. > - Agent Skill: `npx skills add AIsa-team/agent-skills --skill aisa`. Fallback with the AIsa CLI: `aisa skills install aisa`. > - Spending: docs, https://aisa.one/models, https://aisa.one/api, `/v1/models`, and MCP `search`, `list_categories`, `get_details`, `batch_quote`, and the `account` operation are free. Quote the exact calls before running them (MCP `batch_quote`, CLI `aisa quote --json`). If the quote reports `auto_execute_eligible: true`, run it unless the user set a tighter limit or asked only for a quote. Otherwise, tell the user in one message the planned calls, the quoted price, and a total USD budget for the task, then wait for approval. Direct HTTP calls follow the stricter rule at https://aisa.one/docs/get-started/cli.md#direct-http-fallback. Do not make paid calls to test availability. Full rule: https://aisa.one/llms.txt # Update Monitor > Update a monitor. Only explicit fields are changed; pass null to clear webhook/metadata. At least one field required. Cancelled monitors cannot be updated. Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. ## Request contract * **Method and path:** POST /apis/v1/parallel/monitors/\{monitor\_id}/update * **Availability:** enabled * **Request URL template:** [https://api.aisa.one/apis/v1/parallel/monitors/\{monitor\_id\}/update](https://api.aisa.one/apis/v1/parallel/monitors/\{monitor\_id\}/update) * **monitor\_id:** path; required * **Runtime facts:** 5d413ff65ac53e696e28c5a12c4dbbb99e94b7667cbafba2e2c6b9da9156a731 [Complete OpenAPI definition](https://aisa.one/docs/openapi/parallel.ai.json) Effective request and pricing declaration (including authentication and referenced schemas): ```json theme={null} { "operationId": "any_parallel_ai_apis_v1_parallel_monitors_monitor_a0a0af", "method": "POST", "path": "/apis/v1/parallel/monitors/{monitor_id}/update", "servers": [ { "url": "https://api.aisa.one" } ], "parameters": [ { "in": "path", "name": "monitor_id", "required": true, "schema": { "title": "Monitor Id", "type": "string" } } ], "security": [ { "bearerAuth": [] } ], "requestBody": { "content": { "application/json": { "schema": { "description": "Request body to update a monitor.\n\nOnly fields that are explicitly included in the request body are updated.\n`null` clears a field, and is accepted only for the fields that can be\ncleared: `webhook`, `metadata`, and `settings.advanced_settings`. Every\nother field rejects `null`; omit it to leave the current value unchanged.\nTo update type-specific settings on an `event_stream` monitor, include\n`type` and `settings`; pass `settings.query` to update the prompt. If\n`settings` is provided, `type` is required to identify the settings shape.\nThe request must still include at least one field to update; empty updates\nfail validation.", "properties": { "frequency": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Frequency of the monitor. Format: '' where unit is 'h' (hours), 'd' (days), or 'w' (weeks). Must be between 1h and 30d (inclusive). Omit to keep the current frequency; `null` is rejected.", "examples": [ "1h", "12h", "1d", "7d", "30d" ], "title": "Frequency" }, "metadata": { "anyOf": [ { "additionalProperties": { "type": "string" }, "type": "object" }, { "type": "null" } ], "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" } ], "title": "Metadata" }, "processor": { "anyOf": [ { "enum": [ "lite", "base" ], "type": "string" }, { "type": "null" } ], "description": "Processor to use for subsequent monitor runs. `lite` is faster and cheaper; `base` performs more thorough analysis at higher cost and latency. Omit to keep the current processor; `null` is rejected.", "examples": [ "lite", "base" ], "title": "Processor" }, "settings": { "anyOf": [ { "description": "Type-specific update settings for an `event_stream` monitor.", "properties": { "advanced_settings": { "anyOf": [ { "description": "Advanced monitor configuration.", "properties": { "location": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "ISO 3166-1 alpha-2 country code for geo-targeted monitor results.", "examples": [ "us", "gb", "de", "jp" ], "title": "Location" }, "source_policy": { "anyOf": [ { "description": "Source policy for web search results.\n\nPlain domains match that domain and its subdomains. Domain/path entries use\ncase-sensitive path matching at segment boundaries; trailing slashes are ignored,\ndot segments are normalized, and other percent-encoded path spelling is preserved.\nEntries omit schemes, ports, query strings, and fragments. When include_domains is\nnon-empty, it defines the complete allowlist and exclude_domains is ignored.", "properties": { "after_date": { "anyOf": [ { "format": "date", "type": "string" }, { "type": "null" } ], "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" ], "title": "After Date" }, "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" ] ], "items": { "type": "string" }, "title": "Exclude Domains", "type": "array" }, "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" ] ], "items": { "type": "string" }, "title": "Include Domains", "type": "array" } }, "title": "SourcePolicy", "type": "object" }, { "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" ] } ] } }, "title": "AdvancedMonitorSettings", "type": "object" }, { "type": "null" } ], "description": "Advanced monitor configuration. Pass `null` to clear it." }, "query": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Updated search query for the monitor. Use this for minor updates to prompts and instructions only. Major changes to the query may lead to unexpected results in change detection, as the monitor compares new results with what was previously seen. Omit to keep the current query; `null` is rejected.", "examples": [ "Extract recent news about AI" ], "title": "Query" } }, "title": "UpdateMonitorEventStreamSettings", "type": "object" }, { "type": "null" } ], "description": "Type-specific settings to update. Only valid when `type` is `event_stream`. Pass `settings.query` to update the prompt, or `null` for `settings.advanced_settings` to clear it. Omit to leave type-specific settings unchanged; `null` is rejected." }, "type": { "anyOf": [ { "enum": [ "event_stream", "snapshot" ], "type": "string" }, { "type": "null" } ], "description": "Type of the monitor being updated. Required when `settings` is provided; must be `event_stream` (snapshot monitors have no updatable type-specific settings). Omit when `settings` is not provided; `null` is rejected.", "examples": [ "event_stream" ], "title": "Type" }, "webhook": { "anyOf": [ { "description": "Webhook configuration for a monitor.", "properties": { "event_types": { "description": "Event types to send the webhook notifications for.", "items": { "enum": [ "monitor.event.detected", "monitor.execution.completed", "monitor.execution.failed" ], "type": "string" }, "title": "Event Types", "type": "array" }, "url": { "description": "URL for the webhook.", "examples": [ "https://example.com/webhook" ], "title": "Url", "type": "string" } }, "required": [ "url" ], "title": "MonitorWebhook", "type": "object" }, { "type": "null" } ], "description": "Webhook to receive notifications about the monitor's execution." } }, "title": "UpdateMonitorRequest", "type": "object" } } }, "required": true }, "x-aisa-status": "enabled", "x-aisa-pricing": { "cost_contract": "explicit_zero", "customer_pricing": "fixed_success", "default_request_estimate_usd": 0.012, "estimate_source": "profile_seed", "evidence_source": "request_snapshot" }, "components": { "securitySchemes": { "bearerAuth": { "scheme": "bearer", "type": "http" } } } } ``` ## Cost and request rules Published reference price: \$0.012 USD per successful request. Account-specific pricing and final settlement may differ. Published reference values are not an account-specific quote or a settled charge. For endpoints supporting X-AISA-Cost-Mode: quote, obtain a free quote for your exact request before execution; reconcile the settled cost with response metadata and Usage Logs. USD amounts use 1,000,000 integer micro-USD per dollar. * **Default request reference estimate (USD):** 0.012 * **Cost contract:** explicit\_zero * **Settlement evidence source:** request\_snapshot ## OpenAPI ````yaml openapi/parallel.ai.json POST /apis/v1/parallel/monitors/{monitor_id}/update 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-catalogs: parallel.ai: description: '' title: Parallel.ai x-aisa-capabilities: idempotency: Idempotency-Key max_price: X-AISA-Max-Price-USD quote: header: X-AISA-Cost-Mode value: quote x-aisa-document: facts_hash: 5d413ff65ac53e696e28c5a12c4dbbb99e94b7667cbafba2e2c6b9da9156a731 generator_version: '3' 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-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: composer_version: '20' document_hash: sha256:faf7bdc612cf28356fbb13a4aafcba6664c0f5f6176fe3ef56b5c4d887f62c03 facts_hash: 5d413ff65ac53e696e28c5a12c4dbbb99e94b7667cbafba2e2c6b9da9156a731 generator_version: '3' protocol_version: '1' response_pending: [] schema_version: '1' x-aisa-plans: builder: 1 display_plan: payg payg: 1 similarweb_payg: 1 team: 1 version: e70a0959cd1b93b84ae16dffd7a538273ddb9c1d46277b82823c37ff1b6bc0fb x-aisa-provider: parallel.ai servers: - url: https://api.aisa.one security: - bearerAuth: [] paths: /apis/v1/parallel/monitors/{monitor_id}/update: post: tags: - default summary: Update Monitor description: >- Update a monitor. Only explicit fields are changed; pass null to clear webhook/metadata. At least one field required. Cancelled monitors cannot be updated. Published reference price: $0.012 USD per successful request. Account-specific pricing and final settlement may differ. operationId: any_parallel_ai_apis_v1_parallel_monitors_monitor_a0a0af parameters: - in: path name: monitor_id required: true schema: title: Monitor Id type: string requestBody: content: application/json: schema: description: >- Request body to update a monitor. Only fields that are explicitly included in the request body are updated. `null` clears a field, and is accepted only for the fields that can be cleared: `webhook`, `metadata`, and `settings.advanced_settings`. Every other field rejects `null`; omit it to leave the current value unchanged. To update type-specific settings on an `event_stream` monitor, include `type` and `settings`; pass `settings.query` to update the prompt. If `settings` is provided, `type` is required to identify the settings shape. The request must still include at least one field to update; empty updates fail validation. properties: frequency: anyOf: - type: string - type: 'null' description: >- Frequency of the monitor. Format: '' where unit is 'h' (hours), 'd' (days), or 'w' (weeks). Must be between 1h and 30d (inclusive). Omit to keep the current frequency; `null` is rejected. examples: - 1h - 12h - 1d - 7d - 30d title: Frequency metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' 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 title: Metadata processor: anyOf: - enum: - lite - base type: string - type: 'null' description: >- Processor to use for subsequent monitor runs. `lite` is faster and cheaper; `base` performs more thorough analysis at higher cost and latency. Omit to keep the current processor; `null` is rejected. examples: - lite - base title: Processor settings: anyOf: - description: >- Type-specific update settings for an `event_stream` monitor. properties: advanced_settings: anyOf: - description: Advanced monitor configuration. properties: location: anyOf: - type: string - type: 'null' description: >- ISO 3166-1 alpha-2 country code for geo-targeted monitor results. examples: - us - gb - de - jp title: Location source_policy: anyOf: - 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. properties: after_date: anyOf: - format: date type: string - type: 'null' 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' title: After Date 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 items: type: string title: Exclude Domains type: array 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 items: type: string title: Include Domains type: array title: SourcePolicy type: object - 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 title: AdvancedMonitorSettings type: object - type: 'null' description: >- Advanced monitor configuration. Pass `null` to clear it. query: anyOf: - type: string - type: 'null' description: >- Updated search query for the monitor. Use this for minor updates to prompts and instructions only. Major changes to the query may lead to unexpected results in change detection, as the monitor compares new results with what was previously seen. Omit to keep the current query; `null` is rejected. examples: - Extract recent news about AI title: Query title: UpdateMonitorEventStreamSettings type: object - type: 'null' description: >- Type-specific settings to update. Only valid when `type` is `event_stream`. Pass `settings.query` to update the prompt, or `null` for `settings.advanced_settings` to clear it. Omit to leave type-specific settings unchanged; `null` is rejected. type: anyOf: - enum: - event_stream - snapshot type: string - type: 'null' description: >- Type of the monitor being updated. Required when `settings` is provided; must be `event_stream` (snapshot monitors have no updatable type-specific settings). Omit when `settings` is not provided; `null` is rejected. examples: - event_stream title: Type webhook: anyOf: - description: Webhook configuration for a monitor. properties: event_types: description: Event types to send the webhook notifications for. items: enum: - monitor.event.detected - monitor.execution.completed - monitor.execution.failed type: string title: Event Types type: array url: description: URL for the webhook. examples: - https://example.com/webhook title: Url type: string required: - url title: MonitorWebhook type: object - type: 'null' description: >- Webhook to receive notifications about the monitor's execution. title: UpdateMonitorRequest type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ResponseB67C75A8Feba_MonitorResponse' description: Monitor updated successfully. default: content: application/json: schema: {} description: >- Error response; upstream passthrough responses may use provider formats components: schemas: ResponseB67C75A8Feba_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. properties: created_at: description: Timestamp of the creation of the monitor, as an RFC 3339 string. examples: - '2025-01-15T10:30:00Z' format: date-time title: Created At type: string 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 title: Frequency type: string last_run_at: anyOf: - type: string - type: 'null' description: Timestamp of the last run for the monitor, as an RFC 3339 string. examples: - '2025-01-15T10:30:00Z' title: Last Run At metadata: anyOf: - additionalProperties: type: string type: object - type: 'null' 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 title: Metadata monitor_id: description: ID of the monitor. title: Monitor ID type: string output: anyOf: - $ref: '#/components/schemas/ResponseB67C75A8Feba_MonitorSnapshotOutput' - type: 'null' description: >- Runtime output state. Present only for `snapshot` monitors; `null` for `event_stream` monitors. 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`. enum: - lite - base examples: - lite - base title: Processor type: string settings: anyOf: - $ref: >- #/components/schemas/ResponseB67C75A8Feba_MonitorEventStreamResponseSettings - $ref: >- #/components/schemas/ResponseB67C75A8Feba_MonitorSnapshotResponseSettings description: >- Type-specific configuration. Shape is determined by `type`: `MonitorEventStreamResponseSettings` for `event_stream`, `MonitorSnapshotResponseSettings` for `snapshot`. title: Settings status: description: Status of the monitor. enum: - active - cancelled examples: - active - cancelled title: Status type: string type: description: The type of monitor. enum: - event_stream - snapshot examples: - event_stream - snapshot title: Type type: string webhook: anyOf: - $ref: '#/components/schemas/ResponseB67C75A8Feba_MonitorWebhook' - type: 'null' description: Webhook configuration for the monitor. required: - type - monitor_id - status - frequency - processor - created_at - settings title: MonitorResponse type: object ResponseB67C75A8Feba_MonitorSnapshotOutput: description: Runtime output state for a `snapshot` monitor. properties: latest_snapshot: anyOf: - discriminator: mapping: json: '#/components/schemas/ResponseB67C75A8Feba_TaskRunJsonOutput' text: '#/components/schemas/ResponseB67C75A8Feba_TaskRunTextOutput' propertyName: type oneOf: - $ref: '#/components/schemas/ResponseB67C75A8Feba_TaskRunTextOutput' - $ref: '#/components/schemas/ResponseB67C75A8Feba_TaskRunJsonOutput' - type: 'null' 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. title: Latest Snapshot title: MonitorSnapshotOutput type: object ResponseB67C75A8Feba_MonitorEventStreamResponseSettings: description: Type-specific response fields for an `event_stream` monitor. properties: advanced_settings: anyOf: - $ref: >- #/components/schemas/ResponseB67C75A8Feba_AdvancedMonitorSettings - type: 'null' description: Advanced monitor configuration. include_backfill: anyOf: - type: boolean - type: 'null' 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. title: Include Backfill 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. query: description: The search query being monitored. examples: - Extract recent news about AI title: Query type: string required: - query title: MonitorEventStreamResponseSettings type: object ResponseB67C75A8Feba_MonitorSnapshotResponseSettings: description: Configuration settings for a `snapshot` monitor. properties: 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. query: description: >- The original task input from the baseline task run that this monitor tracks. examples: - Extract recent news about AI title: Query type: string task_run_id: description: ID of the task run used as the monitoring baseline. title: Task Run Id type: string required: - task_run_id - query title: MonitorSnapshotResponseSettings type: object ResponseB67C75A8Feba_MonitorWebhook: description: Webhook configuration for a monitor. properties: event_types: description: Event types to send the webhook notifications for. items: enum: - monitor.event.detected - monitor.execution.completed - monitor.execution.failed type: string title: Event Types type: array url: description: URL for the webhook. examples: - https://example.com/webhook title: Url type: string required: - url title: MonitorWebhook type: object ResponseB67C75A8Feba_TaskRunJsonOutput: description: Output from a task that returns JSON. properties: 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`. items: $ref: '#/components/schemas/ResponseB67C75A8Feba_FieldBasis' title: Basis type: array beta_fields: anyOf: - additionalProperties: true type: object - type: 'null' deprecated: true description: >- Deprecated. mcp-server-2025-07-17 is now included directly in the output (e.g. mcp_tool_calls). title: Beta Fields content: additionalProperties: true description: >- Output from the task as a native JSON object, as determined by the output schema of the task spec. title: Content type: object mcp_tool_calls: anyOf: - items: $ref: '#/components/schemas/ResponseB67C75A8Feba_McpToolCall' type: array - type: 'null' description: MCP tool calls made by the task. title: Mcp Tool Calls output_schema: anyOf: - additionalProperties: true type: object - type: 'null' description: >- Output schema for the Task Run. Populated only if the task was executed with an auto schema. title: Output Schema type: const: json description: >- The type of output being returned, as determined by the output schema of the task spec. title: Type type: string required: - basis - type - content title: TaskRunJsonOutput type: object ResponseB67C75A8Feba_TaskRunTextOutput: description: Output from a task that returns text. properties: basis: description: Basis for the output. The basis has a single field 'output'. items: $ref: '#/components/schemas/ResponseB67C75A8Feba_FieldBasis' title: Basis type: array beta_fields: anyOf: - additionalProperties: true type: object - type: 'null' deprecated: true description: >- Deprecated. mcp-server-2025-07-17 is now included directly in the output (e.g. mcp_tool_calls). title: Beta Fields content: description: Text output from the task. title: Content type: string mcp_tool_calls: anyOf: - items: $ref: '#/components/schemas/ResponseB67C75A8Feba_McpToolCall' type: array - type: 'null' description: MCP tool calls made by the task. title: Mcp Tool Calls type: const: text description: >- The type of output being returned, as determined by the output schema of the task spec. title: Type type: string required: - basis - type - content title: TaskRunTextOutput type: object ResponseB67C75A8Feba_AdvancedMonitorSettings: description: Advanced monitor configuration. properties: location: anyOf: - type: string - type: 'null' description: ISO 3166-1 alpha-2 country code for geo-targeted monitor results. examples: - us - gb - de - jp title: Location 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 title: AdvancedMonitorSettings type: object ResponseB67C75A8Feba_JsonSchema: description: JSON schema for a task input or output. properties: json_schema: additionalProperties: true 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 title: Json Schema type: object type: const: json default: json description: The type of schema being defined. Always `json`. title: Type type: string required: - json_schema title: JsonSchema type: object ResponseB67C75A8Feba_FieldBasis: description: Citations and reasoning supporting one field of a task output. properties: citations: default: [] description: List of citations supporting the output field. items: $ref: '#/components/schemas/ResponseB67C75A8Feba_Citation' title: Citations type: array 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 field: description: Name of the output field. title: Field type: string reasoning: description: Reasoning for the output field. title: Reasoning type: string required: - field - reasoning title: FieldBasis type: object ResponseB67C75A8Feba_McpToolCall: description: Result of an MCP tool call. properties: arguments: description: Arguments used to call the MCP tool. title: Arguments type: string content: anyOf: - type: string - type: 'null' description: Output received from the tool call, if successful. title: Content error: anyOf: - type: string - type: 'null' description: Error message if the tool call failed. title: Error server_name: description: Name of the MCP server. title: Server Name type: string tool_call_id: description: Identifier for the tool call. title: Tool Call ID type: string tool_name: description: Name of the tool being called. title: Tool Name type: string required: - tool_call_id - server_name - tool_name - arguments title: McpToolCall type: object ResponseB67C75A8Feba_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. properties: after_date: anyOf: - format: date type: string - type: 'null' 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' title: After Date 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 items: type: string title: Exclude Domains type: array 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 items: type: string title: Include Domains type: array title: SourcePolicy type: object ResponseB67C75A8Feba_Citation: description: A citation for a task output. properties: 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 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 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.