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

# Stream Warm Pool Workspace Updates

> Server-Sent Events stream that delivers live warm-hook stdout/stderr plus status transitions for a single warm pool workspace. The monolith proxies output from the warming sandbox's engine; output is only available while the sandbox is running (i.e. `status` is `warming`). Once the workspace reaches `snapshotting` the sandbox is suspended and the stream stops emitting `output` events — only status transitions and the terminal `complete` event still flow. The stream auto-closes on terminal status (`ready`, `failed`, `expired`, `assigned`). Events emitted: `output` (appended chunk), `status` (transition between `warming` and `snapshotting`), `complete` (terminal with final workspace record), and `error`.



## OpenAPI

````yaml /openapi.json get /v1/warm-pool-workspaces/{workspaceId}/stream
openapi: 3.1.0
info:
  title: Replica API
  version: 2.0.0
  description: >-
    The Replica API allows you to programmatically manage cloud workspaces for
    AI agents. Use this API to manage environments (the org-scoped primitive
    workspaces are created from — including variables, files, skills, MCPs, warm
    hooks, start hooks, and warm pools), create and manage replicas, send
    messages, manage chats, stream events, read connected repositories and
    repository sets, and configure automations.
servers:
  - url: https://api.tryreplicas.com
    description: Production API
security:
  - apiKey: []
tags:
  - name: Environments
    description: >-
      Manage environments — the primitive that workspaces are created from.
      Variables, files, skills, MCPs, warm-hooks, and warm-pools are all scoped
      to an environment. Every organization has a singleton Global environment
      whose values apply to every workspace. Personal environments are scoped to
      the authenticated user and can be standalone or source-backed by a team
      environment.
  - name: Repository
    description: >-
      Read repositories and repository sets connected to your organization.
      Repositories are the underlying GitHub-connection layer; bind them to an
      environment to use them in workspaces.
  - name: Replica
    description: Manage replicas (workspaces) for AI agents
  - name: Terminal
    description: Manage interactive terminal sessions in active workspaces
  - name: Preview
    description: Manage public preview URLs for workspace ports
  - name: Profile
    description: Read and update the authenticated user's profile
  - name: Credentials
    description: >-
      Manage coding-agent credentials for an organization or the authenticated
      user
  - name: Google Search Console
    description: >-
      Read Search Console properties, performance, sitemaps, and URL inspection
      results through a connected Google account
  - name: Slack
    description: Connect Slack identities and route threads to Replicas workspaces
  - name: Linear
    description: Connect Linear identities to Replicas accounts
  - name: Automation
    description: >-
      Create and manage automations that trigger replicas on a schedule or in
      response to events
  - name: Downloads
    description: Download Replicas applications
  - name: Media
    description: >-
      Read workspace media and obtain short-lived download or inline preview
      URLs
  - name: Analytics
    description: >-
      Read aggregated activity and usage metrics for your organization: compute
      minutes, workspaces created by source, and pull request throughput over a
      time range.
  - name: Presence
    description: >-
      Read and report ephemeral member presence: who is online, where they are
      (environment or workspace), and whether they are typing. Presence is
      backed by short-lived keys rather than the database and broadcast to other
      members over the events stream.
paths:
  /v1/warm-pool-workspaces/{workspaceId}/stream:
    get:
      tags:
        - Environments
      summary: Stream Warm Pool Workspace Updates
      description: >-
        Server-Sent Events stream that delivers live warm-hook stdout/stderr
        plus status transitions for a single warm pool workspace. The monolith
        proxies output from the warming sandbox's engine; output is only
        available while the sandbox is running (i.e. `status` is `warming`).
        Once the workspace reaches `snapshotting` the sandbox is suspended and
        the stream stops emitting `output` events — only status transitions and
        the terminal `complete` event still flow. The stream auto-closes on
        terminal status (`ready`, `failed`, `expired`, `assigned`). Events
        emitted: `output` (appended chunk), `status` (transition between
        `warming` and `snapshotting`), `complete` (terminal with final workspace
        record), and `error`.
      operationId: streamWarmPoolWorkspace
      parameters:
        - name: workspaceId
          in: path
          required: true
          description: >-
            Warm pool workspace UUID (from the `id` field returned by [GET
            /v1/warm-pools/{configId}/workspaces](#tag/Environments/operation/listWarmPoolWorkspaces)).
          schema:
            type: string
            format: uuid
      responses:
        '200':
          description: SSE stream of warm pool workspace updates
          content:
            text/event-stream:
              schema:
                type: string
                description: >-
                  SSE events. Each event has `type` in {`output`, `status`,
                  `complete`, `error`} plus an optional `output`, `status`,
                  `workspace`, or `message` payload.
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
components:
  responses:
    BadRequest:
      description: Bad request - Missing or invalid parameters
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized - Invalid or missing API key
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error message
        details:
          type:
            - string
            - 'null'
          description: Additional error details
      required:
        - error
  securitySchemes:
    apiKey:
      type: http
      scheme: bearer
      description: >-
        API key authentication. Obtain your API key from the Replicas dashboard
        under Organization → Settings → API Keys.

````