Skip to content

Stream Execution Events

GET
/api/v1/executions/{execution_id}/events

Stream execution progress via Server-Sent Events.

Reactive endpoint - events pushed as they occur, no polling. Recommended for frontend dashboards and real-time monitoring.

Event types:

  • initiated: Message processing started
  • processing: Message being processed by adapter
  • completed: Message processing completed
  • failed: Message processing failed

The stream ends when:

  • Execution completes (status: completed/failed/cancelled)
  • Timeout reached (default 5 minutes)
  • Client disconnects

Args: execution_id: Execution UUID to stream events for service: Execution service (injected) streamer: Event streamer (injected) timeout: Maximum stream duration in seconds

Returns: EventSourceResponse with SSE stream

Raises: HTTPException: 404 if execution not found, 503 if streamer unavailable

execution_id
required
Execution Id
string
timeout
Timeout

Stream timeout in seconds

number
default: 300 >= 1 <= 3600

Stream timeout in seconds

Successful Response

Resource not found

ErrorResponse

Standard error response matching FastAPI HTTPException format.

This model is used in OpenAPI response declarations for 4xx/5xx errors. The detail field matches FastAPI’s HTTPException structure.

object
detail
required
Detail

Error message (matches FastAPI HTTPException)

string
error_code
Any of:
string
correlation_id
Any of:
string
timestamp
Timestamp

Error timestamp

string format: date-time

Validation Error

HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
input
Input
ctx
Context
object

Event streamer not available

ErrorResponse

Standard error response matching FastAPI HTTPException format.

This model is used in OpenAPI response declarations for 4xx/5xx errors. The detail field matches FastAPI’s HTTPException structure.

object
detail
required
Detail

Error message (matches FastAPI HTTPException)

string
error_code
Any of:
string
correlation_id
Any of:
string
timestamp
Timestamp

Error timestamp

string format: date-time