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

# Server-sent events for an agent run

> The first connection starts the loop; a reconnect replays buffered events after `afterSeq`. **Not mounted in production unless `AGENT_SURFACE=on`.** The agent routes run open-ended loops with file and shell tools, so the surface refuses to mount at all when no credential (`ACCESS_PASSWORD_HASH` or `ORCHESTRATOR_ACCESS_TOKEN`) is configured, and answers 404 when unmounted. In development it mounts but accepts loopback callers only. Spawning the Claude CLI on the host is a further opt-in, `AGENT_CLI=1`, off everywhere by default. See `apps/orchestrator/src/agent-surface.ts`.



## OpenAPI

````yaml /api-reference/orchestrator.openapi.json get /agent/stream
openapi: 3.0.3
info:
  title: Avocado Studio Orchestrator API
  description: >-
    HTTP API exposed by the orchestrator. The brain that runs editor sessions,
    calls the LLMs, and serves draft state to integrated sites.


    The route list is the one the standalone Fastify server registers
    (`apps/orchestrator/src`); the handlers behind most of them live in
    `packages/orchestrator-core/src/http`, so library mode —
    `createOrchestrator()` from `@avocadostudio-ai/site-sdk` — serves the same
    shapes from the same code. Where the two differ, the route says so.


    **Note**: most routes carry no Fastify response schema, so responses are
    described in prose rather than typed here. Request shapes are taken from the
    handler source. See [the API Reference index](/api-reference) for context.


    **Auth**: in the standalone server only the agent surface enforces the
    access gate — `/chat` and `/ops` remain open. `createOrchestrator()` gates
    every route instead. Under that gate `GET /auth/status`, `POST
    /auth/verify`, `GET /health` and `GET /generated-images/*` are public — the
    first two are how a caller obtains a credential, a probe that needs one is
    not a probe, and an image tag on the rendered page cannot send a header —
    while every other route wants the token as `x-access-token`, `Authorization:
    Bearer`, or `?accessToken=` on `EventSource`. A refusal is `401` with
    `{"error":"unauthorized"}`. On a `closed` mount — `NODE_ENV=production` with
    no credential configured and no `auth` hook — that body also carries
    `reason`, the sentence naming the variable that would open it; `error` keeps
    its exact value either way, because that is the field the editor matches on
    to re-prompt.
  version: 0.11.1
servers:
  - url: http://localhost:4200
    description: Local development orchestrator (default port)
security: []
tags:
  - name: Sites
    description: Site registration and listing
  - name: Chat
    description: AI chat / planning endpoints
  - name: Sites Agent
    description: Site onboarding agent (migrate / integrate / create)
  - name: Draft
    description: Draft content read endpoints called by integrated sites
  - name: Publish
    description: Publishing and content snapshot endpoints
  - name: History
    description: Undo / redo / version log
  - name: Auth
    description: Optional access password gate
  - name: Media
    description: Image upload and generation
  - name: Health
    description: Service health and readiness
  - name: Operations
    description: Applying typed content operations directly
  - name: Checks
    description: Site-health check runs and findings
  - name: Restore
    description: Publish snapshots and rolling a draft back to one
  - name: Sessions
    description: Session introspection and admin
  - name: Preview
    description: Preview utilities
  - name: Telemetry
    description: Chat pipeline traces and feedback
  - name: Agent
    description: Open-ended agent loops — gated, and off in production by default
  - name: Jira
    description: Jira as a second input channel
paths:
  /agent/stream:
    get:
      tags:
        - Agent
      summary: Server-sent events for an agent run
      description: >-
        The first connection starts the loop; a reconnect replays buffered
        events after `afterSeq`. **Not mounted in production unless
        `AGENT_SURFACE=on`.** The agent routes run open-ended loops with file
        and shell tools, so the surface refuses to mount at all when no
        credential (`ACCESS_PASSWORD_HASH` or `ORCHESTRATOR_ACCESS_TOKEN`) is
        configured, and answers 404 when unmounted. In development it mounts but
        accepts loopback callers only. Spawning the Claude CLI on the host is a
        further opt-in, `AGENT_CLI=1`, off everywhere by default. See
        `apps/orchestrator/src/agent-surface.ts`.
      parameters:
        - schema:
            type: string
            minLength: 1
          in: query
          name: streamId
          required: true
        - schema:
            type: string
          in: query
          name: afterSeq
          required: false
          description: Last sequence number the client saw.
      responses:
        '200':
          description: An SSE stream of agent events.
          content:
            text/event-stream: {}
        '400':
          description: '`streamId` is required.'
        '410':
          description: Stream not found or expired.

````