Skip to content

API: sse

Status: GA Access: token required API contract: 0.3.0 · capability 2026-09-03.1 View as Markdown Open in Claude Open in ChatGPT

Sse All

Open as a page →

Subscribe to every event channel.

Auth: Authorization: Bearer <token> required

ParameterInRequiredTypeDescription
access_tokenquerynostring | null

Responses:

CodeMeaningBody
200Successful Responseobject
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Sse Integrations

Open as a page →

connection status-change events.

The integrations health-checker emits integration.status whenever a connection’s credential or health status changes.

Auth: Authorization: Bearer <token> required

ParameterInRequiredTypeDescription
access_tokenquerynostring | null

Responses:

CodeMeaningBody
200Successful Responseobject
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Sse Lifecycle

Open as a page →

lifecycle SSE channel.

Emits: lifecycle.transitioned, lifecycle.autorun.completed, lifecycle.message, lifecycle.batch.completed. Source of truth — LifecycleEngine, which publishes only after session.commit. Multi-worker note: in-memory bus is MVP; Redis-backed migration is (same pattern as runs:sse.

Auth: Authorization: Bearer <token> required

ParameterInRequiredTypeDescription
access_tokenquerynostring | null

Responses:

CodeMeaningBody
200Successful Responseobject
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Sse Publish

Open as a page →

Subscribe to publish/deploy progress events.

Auth: Authorization: Bearer <token> required

ParameterInRequiredTypeDescription
access_tokenquerynostring | null

Responses:

CodeMeaningBody
200Successful Responseobject
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Sse Runs

Open as a page →

Subscribe to pipeline-run events — Redis-backed, multi-worker.

Auth: Authorization: Bearer <token> required

ParameterInRequiredTypeDescription
access_tokenquerynostring | null

Responses:

CodeMeaningBody
200Successful Responseobject
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError

Sse Workspace

Open as a page →

Workspace channel.

Emits: spec., issue., defect., comment., agent_action.* events.

Auth: Authorization: Bearer <token> required

ParameterInRequiredTypeDescription
access_tokenquerynostring | null

Responses:

CodeMeaningBody
200Successful Responseobject
401Missing or invalid authentication credentialsErrorResponse
422Validation ErrorHTTPValidationError