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

# Run Workflow Sse

> Start a workflow run and stream its events back as SSE.



## OpenAPI

````yaml /api-reference/openapi.json post /api/workflows/run-sse
openapi: 3.1.0
info:
  title: apowerb API
  description: REST API of the apowerb agentic framework (open-source edition).
  version: 0.1.2
  license:
    name: MIT
    url: https://github.com/apowerb/apowerb/blob/main/LICENSE
servers:
  - url: https://api.example.com
    description: Your apowerb instance
  - url: http://localhost:8000
    description: Local stack
security: []
paths:
  /api/workflows/run-sse:
    post:
      tags:
        - workflows
      summary: Run Workflow Sse
      description: Start a workflow run and stream its events back as SSE.
      operationId: run_workflow_sse_api_workflows_run_sse_post
      requestBody:
        content:
          multipart/form-data:
            schema:
              $ref: >-
                #/components/schemas/Body_run_workflow_sse_api_workflows_run_sse_post
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - HTTPBearer: []
components:
  schemas:
    Body_run_workflow_sse_api_workflows_run_sse_post:
      properties:
        canvas_agent_ids:
          type: string
          title: Canvas Agent Ids
        workflow_id:
          anyOf:
            - type: string
            - type: 'null'
          title: Workflow Id
        config_json:
          anyOf:
            - type: string
            - type: 'null'
          title: Config Json
        file:
          anyOf:
            - type: string
              contentMediaType: application/octet-stream
            - type: 'null'
          title: File
      type: object
      required:
        - canvas_agent_ids
      title: Body_run_workflow_sse_api_workflows_run_sse_post
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer

````

## Related topics

- [Run Agent Sse](/api-reference/adk/run-agent-sse.md)
- [Cancel Workflow](/api-reference/workflows/cancel-workflow.md)
- [SSE streaming](/guides/streaming.md)
- [Sessions and runs](/concepts/sessions-and-runs.md)
