latestOpenAPI 3.1.02026-08-1321263172.6 KB

a232aed4852f

tasks

Stream tasks

Establishes a server streaming connection that delivers task updates in real-time using Server-Sent Events (SSE).

The stream delivers all existing non-terminal tasks when first connected, followed by real-time updates for task creation and status changes. Additionally, heartbeat messages are sent periodically to maintain the connection.

post/api/v1/tasks/stream

Headers

Authorizationstring required

Bearer authentication

Request body

heartbeatIntervalMsinteger

The time interval, in milliseconds, that determines the frequency at which to send heartbeat events. Defaults to 30000 (30 seconds).

rateLimitinteger

The time interval, in milliseconds, after an update for a given task before another one will be sent for the same task. If set, value must be >= 250.

excludePreexistingTasksboolean

Optional flag to only include tasks created or updated after the stream is initiated, and not any previous preexisting tasks. If unset or false, the stream will include any new tasks and task updates, as well as all preexisting tasks.

updateStartTimestring

The datetime string in ISO 8601 format.

parentTaskIdstring

A filter for tasks with a specific parent task ID. Note: This filter is mutually exclusive with all other filter fields (updateStartTime, assignee, statusFilter, taskType). Either provide parentTaskId or any combination of the other filters, but not both.

Response

Returns a stream of task updates as they occur.