> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lyzr.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Stream Execution Events (SSE)

> Opens a Server-Sent Events stream of execution lifecycle events, covering node start and end, errors, approval requests, and completion. The connection stays open up to 30 minutes or until the workflow emits a terminal done event. Each frame is a JSON-encoded execution event.



## OpenAPI

````yaml openapi/superflow.yaml GET /executions/{id}/events
openapi: 3.0.3
info:
  title: Lyzr SuperFlow API
  version: '1.0'
  description: >-
    SuperFlow orchestration API covering workflow CRUD, versions and deployment,
    validation, the node catalog, the execution lifecycle (run, pause, resume,
    terminate, rerun), scheduling, and human-in-the-loop approvals. Agent CRUD
    and agent inference are served by the platform API and are not part of this
    surface.
servers:
  - url: https://inference.studio.lyzr.ai/api
security:
  - ApiKeyAuth: []
tags:
  - name: workflows
    description: >-
      Create, read, update, delete, validate, lock, and share workflow
      definitions.
  - name: workflow-versions
    description: Save the draft as a version and choose which version production runs.
  - name: node-catalog
    description: The contract for every node type, used to build and validate workflows.
  - name: workflow-execution
    description: Run workflows and control the execution lifecycle.
  - name: workflow-schedules
    description: Cron-driven recurring triggers for stored workflows.
  - name: approvals
    description: Human-in-the-loop approval requests raised by running workflows.
paths:
  /executions/{id}/events:
    get:
      tags:
        - workflow-execution
      summary: Stream execution events (SSE)
      description: >-
        Opens a Server-Sent Events stream of execution lifecycle events,
        covering node start and end, errors, approval requests, and completion.
        The connection stays open up to 30 minutes or until the workflow emits a
        terminal done event. Each frame is a JSON-encoded execution event.
      operationId: streamExecutionEvents
      parameters:
        - name: id
          in: path
          required: true
          description: Execution ID
          schema:
            type: string
      responses:
        '200':
          description: SSE stream
          content:
            text/event-stream:
              schema:
                type: string
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          description: Event streaming not configured
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
components:
  schemas:
    ErrorResponse:
      type: object
      properties:
        error:
          type: string
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Lyzr API key. Studio session keys (agk_, ags_) and durable sk- keys are
        accepted. Required on every endpoint except GET /node-types and a
        webhook-triggered execute that carries X-Webhook-Secret.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.