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

# Events stream (SSE)

> Long-lived Server-Sent Events connection that emits real-time progress, completion, and failure events for every job in the workspace. Use this for dashboards and realtime UIs. For a single job, use `GET /v1/jobs/{id}/stream` instead.

A single long-lived HTTP connection that emits Server-Sent Events for every job in your workspace as they make progress. Use it for dashboards and realtime UIs.

## Event types

| Event           | Payload                                            |
| --------------- | -------------------------------------------------- |
| `job:progress`  | `{ jobId, status, completed, total }`              |
| `job:completed` | `{ jobId, status, completed, total, creditsUsed }` |
| `job:failed`    | `{ jobId, error }`                                 |

A keep-alive comment (`: ping`) is sent every 30 seconds so intermediate proxies don't close the connection as idle. Most SSE clients ignore comment frames automatically.

For a stream scoped to a single job (with `progress`, `page`, `error`, and `done` events), use [`GET /v1/jobs/{id}/stream`](/api-reference/jobs/stream) instead.

See [Events](/home/concepts/events) for the full concept guide.


## OpenAPI

````yaml openapi.json GET /v1/events
openapi: 3.1.0
info:
  title: Reader API
  version: 1.0.0
  description: >-
    Reader turns any URL into clean markdown for LLMs. One endpoint (`POST
    /v1/read`) handles scrape, batch, and crawl operations. See
    https://reader.dev/docs for concepts and guides.
servers:
  - url: https://api.reader.dev
    description: Production
security: []
tags:
  - name: Read
    description: Scrape, batch, and crawl operations
  - name: Jobs
    description: Async job management
  - name: Webhooks
    description: Event subscriptions
  - name: Account
    description: API keys, credits, and usage
paths:
  /v1/events:
    get:
      tags:
        - Jobs
      summary: Workspace events stream (SSE)
      description: >-
        Long-lived Server-Sent Events connection that emits real-time progress,
        completion, and failure events for every job in the workspace. Use this
        for dashboards and realtime UIs. For a single job, use `GET
        /v1/jobs/{id}/stream` instead.
      responses:
        '200':
          description: SSE stream that stays open until the client disconnects
          content:
            text/event-stream:
              schema:
                $ref: '#/components/schemas/SseStream'
        '401':
          description: Unauthenticated
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
              example:
                success: false
                error:
                  code: unauthenticated
                  message: Missing or invalid API key
                  docsUrl: https://reader.dev/docs/home/concepts/errors#unauthenticated
              examples:
                unauthenticated:
                  summary: Unauthenticated
                  value:
                    success: false
                    error:
                      code: unauthenticated
                      message: Missing or invalid API key
                      docsUrl: >-
                        https://reader.dev/docs/home/concepts/errors#unauthenticated
      security:
        - ApiKeyAuth: []
components:
  schemas:
    SseStream:
      type: string
      description: >-
        Server-Sent Events stream. Each frame is a line-delimited event with an
        `event:` line, a `data:` line (JSON payload), and a trailing blank line.
        Keep-alive comments (`: ping`) are sent every 30 seconds. See
        [Events](/home/concepts/events) for the full event catalog.
      example: >+
        event: job:progress

        data: {"jobId":"j_abc","status":"processing","completed":45,"total":100}


        event: job:completed

        data:
        {"jobId":"j_abc","status":"completed","completed":100,"total":100,"creditsUsed":100}

    ErrorEnvelope:
      type: object
      properties:
        success:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              $ref: '#/components/schemas/ErrorCode'
            message:
              type: string
            details:
              type: object
              additionalProperties: {}
            docsUrl:
              type: string
              format: uri
          required:
            - code
            - message
            - docsUrl
      required:
        - success
        - error
    ErrorCode:
      type: string
      enum:
        - invalid_request
        - unauthenticated
        - insufficient_credits
        - url_blocked
        - not_found
        - conflict
        - rate_limited
        - concurrency_limited
        - internal_error
        - upstream_unavailable
        - scrape_timeout
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````