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

# Processing progress (SSE)

> SSE progress for a single document.

`text/event-stream` of processing ticks until the document is terminal. Subscribe after upload or reprocess instead of polling.


## OpenAPI

````yaml GET /api/v2/documents/attachments/{att_id}/stream/
openapi: 3.1.0
info:
  title: Abacus Docs API
  version: 1.0.0
  description: |
    REST + SSE surface for Abacus Docs on the same host as the web app
    (`https://abacusdocs.com`). Paths are `/api/v2/…`.

    Authenticate with an organisation API key (`sk-abacus-*`) as a Bearer
    token, or an Auth0 access token. Cross-tenant reads return **404**, not
    403. Page-based lists use `?page=` and `?page_size=`.

    Extraction, reprocess, schema tests, and chat turns spend credits.
    See the help centre Credits pages for rates.
  contact:
    name: Abacus Docs
    url: https://abacusdocs.com/contact
servers:
  - url: https://abacusdocs.com
    description: Production (Extract)
security: []
paths:
  /api/v2/documents/attachments/{att_id}/stream/:
    get:
      tags:
        - v2/documents
      summary: Stream document processing progress over SSE
      description: >-
        Streams ``text/event-stream`` processing-progress frames (``event:
        progress|complete|error``) until the document reaches a terminal status.
        Used by the document viewer to live-update the re-extraction progress
        bar.
      operationId: v2_documents_attachments_stream_retrieve
      parameters:
        - in: path
          name: att_id
          schema:
            type: integer
          required: true
        - in: query
          name: format
          schema:
            type: string
            enum:
              - event-stream
              - json
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DocumentProgressEvent'
            text/event-stream:
              schema:
                $ref: '#/components/schemas/DocumentProgressEvent'
          description: ''
        '404':
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
            text/event-stream:
              schema:
                type: object
                additionalProperties: {}
          description: ''
      security:
        - extractApiKey: []
        - bearerAuth: []
        - cookieAuth: []
components:
  schemas:
    DocumentProgressEvent:
      type: object
      description: |-
        OpenAPI shape of a single SSE processing-progress frame.

        Documentation-only: the live stream ships the Pydantic
        ``ProcessingProgressEvent`` union verbatim (``event: <type>`` + ``data:
        <json>``); this serializer pins the ``data`` payload shape for codegen.
      properties:
        type:
          $ref: '#/components/schemas/TypeEnum'
        status:
          type: string
        progress:
          type: integer
        stage:
          type: string
      required:
        - progress
        - stage
        - status
        - type
    TypeEnum:
      enum:
        - progress
        - complete
        - error
      type: string
      description: |-
        * `progress` - progress
        * `complete` - complete
        * `error` - error
  securitySchemes:
    extractApiKey:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: |
        Organisation API key from Settings → API / `/api/keys/`. The secret is
        shown once. Send `Authorization: Bearer sk-abacus-…`. One active key
        per organisation. Ingest (`/api/v2/ingest/*`) refuses API keys — that
        surface is Auth0-only with `ingest:read` / `ingest:write` scopes.
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: >
        Auth0 access token for a signed-in user. Send `Authorization: Bearer
        <token>`.

        The SPA and desktop agent use this. Prefer an organisation API key for

        server-to-server integrations.
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
      description: |
        Django session cookie from a browser login. Present so the web app can
        call `/api/v2` without a header. Do not rely on this for integrations.

````