> ## 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. # Stream Task Run Events > Streams events for a task run.Returns a stream of events showing progress updates and state changes for the task run.For task runs that did not have enable_events set to true during creation, the frequency of events will be reduced. ## OpenAPI ````yaml openapi/parallel.ai.json GET /apis/v1/parallel/v1beta/tasks/runs/{run_id}/events 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/v1beta/tasks/runs/{run_id}/events: get: tags: - default summary: Stream Task Run Events description: >- Streams events for a task run.Returns a stream of events showing progress updates and state changes for the task run.For task runs that did not have enable_events set to true during creation, the frequency of events will be reduced. operationId: any_parallel_ai_apis_v1_parallel_v1beta_tasks_run_c79df4 parameters: - name: run_id in: path required: true schema: type: string title: Run Id responses: '200': description: Successful Response content: text/event-stream: schema: oneOf: - $ref: >- #/components/schemas/ResponseD6D099F50311_TaskRunProgressStatsEvent - $ref: >- #/components/schemas/ResponseD6D099F50311_TaskRunProgressMessageEvent - $ref: '#/components/schemas/ResponseD6D099F50311_TaskRunEvent' - $ref: '#/components/schemas/ResponseD6D099F50311_ErrorEvent' discriminator: propertyName: type mapping: task_run.progress_stats: >- #/components/schemas/ResponseD6D099F50311_TaskRunProgressStatsEvent task_run.progress_msg.plan: >- #/components/schemas/ResponseD6D099F50311_TaskRunProgressMessageEvent task_run.progress_msg.search: >- #/components/schemas/ResponseD6D099F50311_TaskRunProgressMessageEvent task_run.progress_msg.result: >- #/components/schemas/ResponseD6D099F50311_TaskRunProgressMessageEvent task_run.progress_msg.tool_call: >- #/components/schemas/ResponseD6D099F50311_TaskRunProgressMessageEvent task_run.progress_msg.exec_status: >- #/components/schemas/ResponseD6D099F50311_TaskRunProgressMessageEvent task_run.state: '#/components/schemas/ResponseD6D099F50311_TaskRunEvent' error: '#/components/schemas/ResponseD6D099F50311_ErrorEvent' title: >- Response 200 Tasks Runs Events Get V1Beta Tasks Runs Run Id Events Get example: type: task_run.progress_msg.plan message: Planning task... timestamp: '2025-04-23T20:21:48.037943Z' default: content: application/json: schema: {} description: >- Error response; upstream passthrough responses may use provider formats components: schemas: ResponseD6D099F50311_TaskRunProgressStatsEvent: properties: type: type: string const: task_run.progress_stats title: Type description: Event type; always 'task_run.progress_stats'. source_stats: $ref: '#/components/schemas/ResponseD6D099F50311_TaskRunSourceStats' description: Source stats describing progress so far. progress_meter: type: number title: Progress Meter description: >- Completion percentage of the task run. Ranges from 0 to 100 where 0 indicates no progress and 100 indicates completion. type: object required: - type - source_stats - progress_meter title: TaskRunProgressStatsEvent description: A progress update for a task run. ResponseD6D099F50311_TaskRunProgressMessageEvent: properties: type: type: string enum: - task_run.progress_msg.plan - task_run.progress_msg.search - task_run.progress_msg.result - task_run.progress_msg.tool_call - task_run.progress_msg.exec_status title: Type description: Event type; always starts with 'task_run.progress_msg'. message: type: string title: Message description: Progress update message. timestamp: anyOf: - type: string - type: 'null' title: Timestamp description: Timestamp of the message. type: object required: - type - message - timestamp title: TaskRunProgressMessageEvent description: A message for a task run progress update. ResponseD6D099F50311_TaskRunEvent: properties: type: type: string const: task_run.state title: Type description: Event type; always 'task_run.state'. event_id: anyOf: - type: string - type: 'null' title: Event ID description: >- Cursor to resume the event stream. Always empty for non Task Group runs. input: anyOf: - $ref: '#/components/schemas/ResponseD6D099F50311_TaskRunInput' - type: 'null' description: Input to the run; included only if requested. run: $ref: '#/components/schemas/ResponseD6D099F50311_TaskRun' description: Task run object. output: anyOf: - oneOf: - $ref: '#/components/schemas/ResponseD6D099F50311_TaskRunTextOutput' - $ref: '#/components/schemas/ResponseD6D099F50311_TaskRunJsonOutput' discriminator: propertyName: type mapping: json: '#/components/schemas/ResponseD6D099F50311_TaskRunJsonOutput' text: '#/components/schemas/ResponseD6D099F50311_TaskRunTextOutput' - type: 'null' title: Output description: >- Output from the run; included only if requested and if status == `completed`. type: object required: - type - event_id - run title: TaskRunEvent description: |- Event when a task run transitions to a non-active status. May indicate completion, cancellation, or failure. ResponseD6D099F50311_ErrorEvent: properties: type: type: string const: error title: Type description: Event type; always 'error'. error: $ref: '#/components/schemas/ResponseD6D099F50311_Error' description: Error. type: object required: - type - error title: ErrorEvent description: Event indicating an error. ResponseD6D099F50311_TaskRunSourceStats: properties: num_sources_considered: anyOf: - type: integer - type: 'null' title: Num Sources Considered description: Number of sources considered in processing the task. num_sources_read: anyOf: - type: integer - type: 'null' title: Num Sources Read description: Number of sources read in processing the task. sources_read_sample: anyOf: - items: type: string type: array - type: 'null' title: Sources Read Sample description: A sample of URLs of sources read in processing the task. type: object required: - num_sources_considered - num_sources_read - sources_read_sample title: TaskRunSourceStats description: Source stats for a task run. ResponseD6D099F50311_TaskRunInput: properties: processor: type: string title: Processor description: Processor to use for the task. examples: - base metadata: anyOf: - additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean type: object - type: 'null' title: Metadata description: >- User-provided metadata stored with the run. Keys and values must be strings with a maximum length of 16 and 512 characters respectively. source_policy: anyOf: - $ref: '#/components/schemas/ResponseD6D099F50311_SourcePolicy' - type: 'null' description: >- Optional source policy governing preferred and disallowed domains in web search results. advanced_settings: anyOf: - $ref: '#/components/schemas/ResponseD6D099F50311_TaskAdvancedSettings' - type: 'null' description: Advanced search configuration for the task run. task_spec: anyOf: - $ref: '#/components/schemas/ResponseD6D099F50311_TaskSpec' - type: 'null' description: Task specification. If unspecified, defaults to auto output schema. input: anyOf: - type: string - additionalProperties: true type: object title: Input description: Input to the task, either text or a JSON object. examples: - What was the GDP of France in 2023? - '{"country": "France", "year": 2023}' previous_interaction_id: anyOf: - type: string - type: 'null' title: Previous Interaction Id description: Interaction ID to use as context for this request. mcp_servers: anyOf: - items: $ref: '#/components/schemas/ResponseD6D099F50311_McpServer' type: array - type: 'null' title: Mcp Servers description: Optional list of MCP servers to use for the run. enable_events: anyOf: - type: boolean - type: 'null' title: Enable Events description: >- Controls tracking of task run execution progress. When set to true, progress events are recorded and can be accessed via the [Task Run events](https://docs.parallel.ai/api-reference) endpoint. When false, no progress events are tracked. Note that progress tracking cannot be enabled after a run has been created. The flag is set to true by default for premium processors (pro and above). webhook: anyOf: - $ref: '#/components/schemas/ResponseD6D099F50311_Webhook' - type: 'null' description: >- Callback URL (webhook endpoint) that will receive an HTTP POST when the run completes. This feature is not available via the Python SDK. type: object required: - processor - input title: TaskRunInput description: Request to run a task. ResponseD6D099F50311_TaskRun: properties: run_id: type: string title: Run ID description: ID of the task run. examples: - trun_e0083b6aac0544eb8686e8d2a76533d2 interaction_id: type: string title: Interaction ID description: >- Identifier for this interaction. Pass this value as `previous_interaction_id` to reuse context for a future request. examples: - trun_e0083b6aac0544eb8686e8d2a76533d2 status: type: string enum: - queued - action_required - running - completed - failed - cancelling - cancelled title: Status description: Status of the run. examples: - queued - action_required - running - completed - failed - cancelling - cancelled is_active: type: boolean title: Is Active description: >- Whether the run is currently active, i.e. status is one of {'cancelling', 'queued', 'running'}. warnings: anyOf: - items: $ref: '#/components/schemas/ResponseD6D099F50311_Warning' type: array - type: 'null' title: Warnings description: Warnings for the run, if any. examples: - [] error: anyOf: - $ref: '#/components/schemas/ResponseD6D099F50311_Error' - type: 'null' description: Error for the run, present only if status is 'failed'. processor: type: string title: Processor description: Processor used for the run. examples: - base metadata: anyOf: - additionalProperties: anyOf: - type: string - type: integer - type: number - type: boolean type: object - type: 'null' title: Metadata description: User-provided metadata stored with the run. examples: - {} taskgroup_id: anyOf: - type: string - type: 'null' title: Taskgroup ID description: ID of the taskgroup to which the run belongs. created_at: anyOf: - type: string - type: 'null' title: Created At description: Timestamp of the creation of the task, as an RFC 3339 string. examples: - '2025-04-24T18:56:22.513132Z' modified_at: anyOf: - type: string - type: 'null' title: Modified At description: >- Timestamp of the last modification to the task, as an RFC 3339 string. examples: - '2025-04-24T18:56:22.513132Z' type: object required: - run_id - interaction_id - status - is_active - processor - created_at - modified_at title: TaskRun description: Status of a task run. ResponseD6D099F50311_TaskRunTextOutput: properties: basis: items: $ref: '#/components/schemas/ResponseD6D099F50311_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/ResponseD6D099F50311_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. ResponseD6D099F50311_TaskRunJsonOutput: properties: basis: items: $ref: '#/components/schemas/ResponseD6D099F50311_FieldBasis' type: array title: Basis description: >- Basis for each top-level field in the JSON output. Per-list-element basis entries are available only when the `parallel-beta: field-basis-2025-11-25` header is supplied. 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/ResponseD6D099F50311_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. ResponseD6D099F50311_Error: properties: ref_id: type: string title: Reference ID description: Reference ID for the error. message: type: string title: Message description: Human-readable message. detail: anyOf: - additionalProperties: true type: object - type: 'null' title: Detail description: Optional detail supporting the error. type: object required: - ref_id - message title: Error description: An error message. ResponseD6D099F50311_SourcePolicy: properties: include_domains: items: type: string type: array title: Include Domains description: >- List of domains to restrict the results to. If specified, only sources from these domains will be included. Accepts plain domains (e.g., example.com, subdomain.example.gov) or bare domain extension starting with a period (e.g., .gov, .edu, .co.uk). The combined number of domains in include_domains and exclude_domains cannot exceed 200. examples: - - wikipedia.org - usa.gov - .edu exclude_domains: items: type: string type: array title: Exclude Domains description: >- List of domains to exclude from results. If specified, sources from these domains will be excluded. Accepts plain domains (e.g., example.com, subdomain.example.gov) or bare domain extension starting with a period (e.g., .gov, .edu, .co.uk). The combined number of domains in include_domains and exclude_domains cannot exceed 200. examples: - - reddit.com - x.com - .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. This policy governs which sources are allowed/disallowed in results. ResponseD6D099F50311_TaskAdvancedSettings: properties: location: anyOf: - type: string - type: 'null' title: Location description: ISO 3166-1 alpha-2 country code for geo-targeted search results. examples: - us - gb - de - jp type: object title: TaskAdvancedSettings description: Advanced search configuration for a task run. ResponseD6D099F50311_TaskSpec: properties: output_schema: anyOf: - $ref: '#/components/schemas/ResponseD6D099F50311_JsonSchema' - $ref: '#/components/schemas/ResponseD6D099F50311_TextSchema' - $ref: '#/components/schemas/ResponseD6D099F50311_AutoSchema' - type: string title: Output Schema description: >- JSON schema or text fully describing the desired output from the task. Descriptions of output fields will determine the form and content of the response. A bare string is equivalent to a text schema with the same description. input_schema: anyOf: - type: string - $ref: '#/components/schemas/ResponseD6D099F50311_JsonSchema' - $ref: '#/components/schemas/ResponseD6D099F50311_TextSchema' - type: 'null' title: Input Schema description: >- Optional JSON schema or text description of expected input to the task. A bare string is equivalent to a text schema with the same description. type: object required: - output_schema title: TaskSpec description: >- Specification for a task. Auto output schemas can be specified by setting `output_schema={"type":"auto"}`. Not specifying a TaskSpec is the same as setting an auto output schema. For convenience bare strings are also accepted as input or output schemas. ResponseD6D099F50311_McpServer: properties: type: type: string const: url title: Type description: Type of MCP server being configured. Always `url`. default: url url: type: string title: Url description: URL of the MCP server. headers: anyOf: - additionalProperties: type: string format: password writeOnly: true type: object - type: 'null' title: Headers description: Headers for the MCP server. name: type: string title: Name description: Name of the MCP server. allowed_tools: anyOf: - items: type: string type: array - type: 'null' title: Allowed Tools description: List of allowed tools for the MCP server. type: object required: - url - name title: McpServer description: MCP server configuration. ResponseD6D099F50311_Webhook: properties: url: type: string title: Url description: URL for the webhook. event_types: items: type: string enum: - task_run.status type: array title: Event Types description: Event types to send the webhook notifications for. default: [] type: object required: - url title: Webhook description: Webhooks for Task Runs. ResponseD6D099F50311_Warning: properties: type: type: string enum: - spec_validation_warning - input_validation_warning - warning title: Type description: >- Type of warning. Note that adding new warning types is considered a backward-compatible change. examples: - spec_validation_warning - input_validation_warning message: type: string title: Message description: Human-readable message. detail: anyOf: - additionalProperties: true type: object - type: 'null' title: Detail description: Optional detail supporting the warning. type: object required: - type - message title: Warning description: Human-readable message for a task. ResponseD6D099F50311_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/ResponseD6D099F50311_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 ResponseD6D099F50311_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. ResponseD6D099F50311_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. ResponseD6D099F50311_TextSchema: properties: description: anyOf: - type: string - type: 'null' title: Description description: A text description of the desired output from the task. examples: - GDP in USD for the year, formatted like '$3.1 trillion (2023)' type: type: string const: text title: Type description: The type of schema being defined. Always `text`. default: text type: object title: TextSchema description: Text description for a task input or output. ResponseD6D099F50311_AutoSchema: properties: type: type: string const: auto title: Type description: The type of schema being defined. Always `auto`. default: auto type: object title: AutoSchema description: Auto schema for a task input or output. ResponseD6D099F50311_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.