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

# Stream live activity for a whole workspace

> Opens ONE Server-Sent Events (SSE) stream carrying live activity for
every fleet the caller can read in the workspace. It is the Fleets Wall's
single connection, replacing one stream per tile.

The first frame is `event: hello`. Its `data` is
`{"kind":"hello","fleet_ids":[...]}` for the current readable fleet set.

Activity frame `data` contains the publisher payload with `fleet_id`
added as the leading field. The client routes each frame by that tag.

A stalled client can overflow its bounded server queue. The server then
sends `event: catching_up` with `{"kind":"catching_up","dropped":N}`.
`dropped` is the new drop count since the previous signal.

Control frames use identifier 0 and do not advance the activity sequence.
Activity identifiers start at 0 for each connection. The route ignores
`Last-Event-ID`.

The connection adjusts its fan-in as fleets appear or disappear. A caller
whose workspace access is revoked stops receiving on the next refresh. At
capacity the route returns 503 `UZ-API-002` with `Retry-After`. After a
reconnect opens, recover the gap through
`GET /v1/workspaces/{workspace_id}/events`.




## OpenAPI

````yaml https://raw.githubusercontent.com/agentsfleet/agentsfleet/main/public/openapi.json get /v1/workspaces/{workspace_id}/events/stream
openapi: 3.1.0
info:
  title: agentsfleet Control Plane API
  version: 1.0.0
  description: API for managing workspaces, fleets, triggers, and runs.
  contact:
    name: agentsfleet
    url: https://agentsfleet.net
servers:
  - url: https://api.agentsfleet.net
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Health
    description: System status and readiness probes
    x-mintlify:
      navigation: Health
  - name: Authentication
    description: Command Line Interface (CLI) sign-in sessions and GitHub sign-in
    x-mintlify:
      navigation: Authentication
  - name: Workspaces
    description: Create and manage workspaces
    x-mintlify:
      navigation: Workspaces
  - name: Tenant
    description: Manage tenant provider settings and models
    x-mintlify:
      navigation: Tenant
  - name: auth-identity-events
    description: >-
      Process signed account events from Clerk. This route is not for customer
      fleets.
    x-mintlify:
      navigation: Auth Identity Events
  - name: Fleets
    description: Create, configure, and run fleets
    x-mintlify:
      navigation: Fleets
  - name: Schedules
    description: Manage and receive scheduled Fleet events
    x-mintlify:
      navigation: Schedules
  - name: Memory
    description: Read and search saved fleet memory
    x-mintlify:
      navigation: Memory
  - name: Secrets
    description: Manage named secrets for fleets in a workspace
    x-mintlify:
      navigation: Secrets
  - name: Admin
    description: Manage shared provider keys and models
    x-mintlify:
      navigation: Admin
  - name: Billing
    description: Read tenant balances and charge records
    x-mintlify:
      navigation: Billing
  - name: Integration Grants
    description: Manage fleet access to third-party services
    x-mintlify:
      navigation: Integration Grants
  - name: Connectors
    description: Connect workspaces to third-party providers
    x-mintlify:
      navigation: Connectors
  - name: Fleet Keys
    description: Manage keys that let external clients call a fleet
    x-mintlify:
      navigation: Fleet Keys
  - name: API Keys
    description: Manage tenant admin API keys
    x-mintlify:
      navigation: API Keys
  - name: Webhooks
    description: Receive signed events and approval decisions
    x-mintlify:
      navigation: Webhooks
  - name: Approvals
    description: List, inspect, and resolve pending approvals
    x-mintlify:
      navigation: Approvals
  - name: Fleet
    description: Enroll and manage runners
    x-mintlify:
      navigation: Fleet
  - name: Fleet Bundles
    description: Manage fleet source bundles in a workspace
    x-mintlify:
      navigation: Fleet Bundles
  - name: Fleet library
    description: Browse and add reusable fleet sources
    x-mintlify:
      navigation: Fleet library
  - name: Model Library
    description: List models available to the tenant
    x-mintlify:
      navigation: Model Library
paths:
  /v1/workspaces/{workspace_id}/events/stream:
    get:
      tags:
        - Workspaces
      summary: Stream live activity for a whole workspace
      description: >
        Opens ONE Server-Sent Events (SSE) stream carrying live activity for

        every fleet the caller can read in the workspace. It is the Fleets
        Wall's

        single connection, replacing one stream per tile.


        The first frame is `event: hello`. Its `data` is

        `{"kind":"hello","fleet_ids":[...]}` for the current readable fleet set.


        Activity frame `data` contains the publisher payload with `fleet_id`

        added as the leading field. The client routes each frame by that tag.


        A stalled client can overflow its bounded server queue. The server then

        sends `event: catching_up` with `{"kind":"catching_up","dropped":N}`.

        `dropped` is the new drop count since the previous signal.


        Control frames use identifier 0 and do not advance the activity
        sequence.

        Activity identifiers start at 0 for each connection. The route ignores

        `Last-Event-ID`.


        The connection adjusts its fan-in as fleets appear or disappear. A
        caller

        whose workspace access is revoked stops receiving on the next refresh.
        At

        capacity the route returns 503 `UZ-API-002` with `Retry-After`. After a

        reconnect opens, recover the gap through

        `GET /v1/workspaces/{workspace_id}/events`.
      operationId: stream_workspace_events
      parameters:
        - name: workspace_id
          in: path
          required: true
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: SSE stream opened.
          content:
            text/event-stream:
              schema:
                type: string
                description: >
                  SSE-formatted `hello`, tagged activity, and `catching_up`
                  frames. Workspace control frames do not carry `fleet_id`.
        default:
          $ref: '#/components/responses/Error'
      security:
        - BearerAuth: []
components:
  responses:
    Error:
      description: RFC 7807 problem detail error response
      content:
        application/problem+json:
          schema:
            $ref: '#/components/schemas/ErrorBody'
  schemas:
    ErrorBody:
      type: object
      description: RFC 7807 problem detail error response (application/problem+json)
      required:
        - docs_uri
        - title
        - detail
        - error_code
        - request_id
      properties:
        docs_uri:
          type: string
          format: uri
          description: Stable link to documentation for this error code
          example: https://docs.agentsfleet.net/api-reference/error-codes#UZ-AGT-009
        title:
          type: string
          description: Short human-readable label, same for every occurrence of this code
          example: Fleet not found
        detail:
          type: string
          description: Instance-specific context describing what went wrong
          example: No fleet with id 'abc123' in this workspace.
        error_code:
          type: string
          description: Machine-readable error code
          example: UZ-AGT-009
        request_id:
          type: string
          description: Correlation ID for this request
        current_state:
          type: string
          description: >-
            Resource state that blocked the requested change. Present only on
            409 responses.
          example: paused
        user_message:
          type: string
          description: >
            Plain message safe to show to a user. Present only when an error
            defines one.


            Use `detail` or `title` when this field is absent.
          example: >-
            We couldn't find that Fleet. It may have been deleted, or the ID
            doesn't match one in this workspace.
        etag:
          type: string
          description: >-
            Resource version returned on 412 responses so the caller can refetch
            and retry.
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >-
        Obtain a token via the CLI auth flow (POST /v1/auth/sessions) or GitHub
        OAuth

````