Subscribe to events (SSE)

GET

/api/v1/events

Local development server

Opens a Server-Sent Events stream for real-time updates. Optionally filter by projectId and agentType to receive events for a single project. Event types: worktree_state, project_state, worktree_list_changed, budget_exceeded, budget_container_stopped, heartbeat, server_shutdown, runtime_status, agent_status.

Parameters

Query Parameters

projectId

string

Filter events to this project ID

agentType

string

Filter events to this agent type

Responses

200

SSE event stream

string

500

Internal Server Error

object

code

string

Allowed values: INVALID_BODY INVALID_CONTAINER_ID INVALID_CONTAINER_NAME INVALID_WORKTREE_ID INVALID_WORKTREE_NAME REQUIRED_FIELD INVALID_PATH INVALID_NETWORK_CONFIG NOT_A_DIRECTORY NOT_FOUND NAME_TAKEN NOT_CONFIGURED STALE_MOUNTS BUDGET_EXCEEDED PROXY_ERROR INTERNAL

error

string

503

Event streaming not configured

object

code

string

error

string