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

# Get Response Streaming Status

> Returns the state and queue progress of a website's response-streaming run. By default reports the latest run; pass `workflow_id` to read a specific one. When no run has ever been started, `state` is `idle` and the config/progress fields are zeroed or null.



## OpenAPI

````yaml /api-reference/openapi.json get /api/v1/response-streaming/status
openapi: 3.1.0
info:
  title: AthenaHQ API
  description: >-
    AthenaHQ API provides programmatic access to manage your websites and
    prompts for AI-powered content optimization.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Production server
security:
  - apiKey: []
tags:
  - name: Basics
    description: Core API operations for managing websites and prompts
  - name: Metrics
    description: Metrics and analytics endpoints for tracking AI visibility
  - name: Billing
    description: Billing and credits endpoints for managing usage
  - name: Team Management
    description: Endpoints for managing team members and invitations
  - name: Groups
    description: Endpoints for managing groups of websites
  - name: Content
    description: >-
      Endpoints for accessing Content Hub data — tabs, tracked URLs, and per-URL
      prompt breakdowns.
  - name: Pitch Workspace
    description: >-
      Endpoints for accessing pitch workspace reports — org-scoped pitch runs
      with competitors, prompts, attributes, and aggregate metrics.
paths:
  /api/v1/response-streaming/status:
    get:
      tags:
        - Basics
      summary: Get Response Streaming Status
      description: >-
        Returns the state and queue progress of a website's response-streaming
        run. By default reports the latest run; pass `workflow_id` to read a
        specific one. When no run has ever been started, `state` is `idle` and
        the config/progress fields are zeroed or null.
      operationId: getResponseStreamingStatus
      parameters:
        - name: website_id
          in: query
          required: true
          description: The ID of the website to read run status for.
          schema:
            type: string
            format: uuid
        - name: workflow_id
          in: query
          required: false
          description: Read a specific run instead of the latest one.
          schema:
            type: string
      responses:
        '200':
          description: Current run state and progress
          content:
            application/json:
              schema:
                type: object
                properties:
                  state:
                    type: string
                    enum:
                      - idle
                      - running
                      - completed
                      - failed
                      - cancelled
                  workflow_id:
                    type: string
                    nullable: true
                  created_at:
                    type: string
                    nullable: true
                  updated_at:
                    type: string
                    nullable: true
                  is_scheduled:
                    type: boolean
                    nullable: true
                  config:
                    type: object
                    properties:
                      mode:
                        type: string
                        enum:
                          - all_prompts
                          - selected_prompts
                        nullable: true
                      selected_prompt_count:
                        type: integer
                        nullable: true
                      models:
                        type: object
                        additionalProperties:
                          type: boolean
                        nullable: true
                      prompt_variations:
                        type: integer
                        nullable: true
                      use_personas:
                        type: boolean
                        nullable: true
                      use_locations:
                        type: boolean
                        nullable: true
                      only_locations:
                        type: boolean
                        nullable: true
                    required:
                      - mode
                      - selected_prompt_count
                      - models
                      - prompt_variations
                      - use_personas
                      - use_locations
                      - only_locations
                  progress:
                    type: object
                    properties:
                      pending:
                        type: integer
                      processing:
                        type: integer
                      completed:
                        type: integer
                      failed:
                        type: integer
                      total:
                        type: integer
                      percentage:
                        type: number
                        minimum: 0
                        maximum: 100
                    required:
                      - pending
                      - processing
                      - completed
                      - failed
                      - total
                      - percentage
                required:
                  - state
                  - workflow_id
                  - config
                  - progress
        '400':
          description: Bad request - Invalid parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized - Invalid or missing API key
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden - You don't have access to this website
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Too many requests - Rate limit exceeded. Retry after a short delay.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Error:
      type: object
      description: Error response object
      required:
        - error
      properties:
        error:
          type: string
          description: Error message describing what went wrong
          example: Unauthorized
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        API key for authentication. You can create one
        [here](https://app.athenahq.ai/organization?tab=api).

````