Stream as agent

Beta
Establishes a server streaming connection that delivers tasks to taskable agents for execution using Server-Sent Events (SSE). This method creates a connection from the Tasks API to an agent that streams relevant tasks to the listener agent. The agent receives a stream of tasks that match the entities specified by the tasks' selector criteria. The stream delivers three types of requests: - `ExecuteRequest`: Contains a new task for the agent to execute - `CancelRequest`: Indicates a task should be canceled - `CompleteRequest`: Indicates a task should be completed Additionally, heartbeat messages are sent periodically to maintain the connection. This is recommended method for taskable agents to receive and process tasks in real-time. Agents should maintain connection to this stream and process incoming tasks according to their capabilities. When an agent receives a task, it should update the task status using the `UpdateStatus` endpoint to provide progress information back to Tasks API.

Authentication

AuthorizationBearer
Bearer token using a JWT

Request

This endpoint expects an object.
agentSelectorobjectOptional
The selector criteria to determine which tasks the agent receives.
heartbeatIntervalMsintegerOptional
The time interval, defined in seconds, that determines the frequency at which to send heartbeat events. Defaults to 30s.

Response

Returns a stream of tasks to the agent as they become available.
heartbeatobject
OR
agent_requestobject

Errors