> ## 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.

# Obtener estado de la obtención de respuestas

> Devuelve el estado completo y el progreso de la cola de respuestas de una ejecución de recopilación del sitio web. Por defecto informa de la última; pasa `workflow_id` para una concreta. El progreso solo mide recopilación, así que `state` puede seguir `running` con `progress.percentage` en 100 mientras terminan los análisis posteriores. Solo `state: "completed"` indica que ha terminado todo. `saved_response_progress` cuenta por separado respuestas guardadas distintas frente a la solicitud original, con una instantánea inmutable del primer resultado definitivo. Si nunca se ha iniciado una ejecución, `state` es `idle` y configuración y progreso están a cero o null.



## OpenAPI

````yaml es/api-reference/openapi.json get /api/v1/response-streaming/status
openapi: 3.1.0
info:
  title: API de AthenaHQ
  description: >-
    La API de AthenaHQ ofrece acceso programático para gestionar tus sitios web
    y consultas para optimizar el contenido con IA.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Servidor de producción
security:
  - apiKey: []
tags:
  - name: Basics
    description: Operaciones principales de la API para gestionar sitios web y consultas
  - name: Metrics
    description: Endpoints de métricas y análisis para monitorizar la visibilidad en IA
  - name: Billing
    description: Endpoints de facturación y créditos para gestionar el uso
  - name: Team Management
    description: Endpoints para gestionar miembros del equipo e invitaciones
  - name: Groups
    description: Endpoints para gestionar grupos de sitios web
  - name: Content
    description: >-
      Endpoints para acceder a los datos del centro de contenidos: pestañas, URL
      monitorizadas y desglose de consultas por URL.
  - name: Pitch Workspace
    description: >-
      Endpoints para acceder a los informes del espacio de propuestas:
      ejecuciones de propuestas con alcance de organización, con competidores,
      consultas, atributos y métricas agregadas.
  - name: Knowledge Base
    description: >-
      Endpoints para leer la base de conocimientos de la marca: datos aprobados
      sobre la marca y los pilares que los organizan.
paths:
  /api/v1/response-streaming/status:
    get:
      tags:
        - Basics
      summary: Obtener estado de la obtención de respuestas
      description: >-
        Devuelve el estado completo y el progreso de la cola de respuestas de
        una ejecución de recopilación del sitio web. Por defecto informa de la
        última; pasa `workflow_id` para una concreta. El progreso solo mide
        recopilación, así que `state` puede seguir `running` con
        `progress.percentage` en 100 mientras terminan los análisis posteriores.
        Solo `state: "completed"` indica que ha terminado todo.
        `saved_response_progress` cuenta por separado respuestas guardadas
        distintas frente a la solicitud original, con una instantánea inmutable
        del primer resultado definitivo. Si nunca se ha iniciado una ejecución,
        `state` es `idle` y configuración y progreso están a cero o null.
      operationId: getResponseStreamingStatus
      parameters:
        - name: website_id
          in: query
          required: true
          description: ID del sitio web cuyo estado de ejecución se consultará.
          schema:
            type: string
            format: uuid
        - name: workflow_id
          in: query
          required: false
          description: Consultar una ejecución concreta en lugar de la más reciente.
          schema:
            type: string
      responses:
        '200':
          description: Estado y progreso de la ejecución actual
          content:
            application/json:
              schema:
                type: object
                properties:
                  state:
                    type: string
                    description: >-
                      Estado de toda la ejecución. Solo `completed` significa
                      que ha terminado toda la ejecución, incluidos los análisis
                      posteriores. `running` puede coexistir con un progreso de
                      respuestas del 100 %.
                    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
                  finish_reason:
                    type: string
                    description: >-
                      Motivo de fin de una ejecución `failed` o `cancelled`.
                      `credits_exhausted`: sin créditos. `credits_paused`:
                      asignación pausada por el socio. `subscription_inactive`,
                      `organization_deleted`. `entitlement_unreadable`: no se
                      pudo leer la facturación durante la ejecución; la carga
                      retroactiva reintenta las respuestas pendientes.
                      `cancelled_by_user`. `responses_failed`: recopilación
                      terminada con respuestas fallidas. `items_stuck`,
                      `attribute_extraction_failed`, `workflow_error`, `stale`.
                      Null mientras se ejecuta, si termina correctamente o si es
                      anterior a este campo.
                    enum:
                      - credits_exhausted
                      - credits_paused
                      - subscription_inactive
                      - organization_deleted
                      - entitlement_unreadable
                      - cancelled_by_user
                      - responses_failed
                      - items_stuck
                      - attribute_extraction_failed
                      - workflow_error
                      - stale
                    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
                    description: >-
                      Mide únicamente la recopilación de respuestas. Estos
                      recuentos de cola no indican que los análisis posteriores
                      estén listos.
                    properties:
                      pending:
                        type: integer
                      processing:
                        type: integer
                      completed:
                        type: integer
                      failed:
                        type: integer
                      total:
                        type: integer
                      percentage:
                        type: number
                        description: >-
                          Porcentaje de elementos de la cola de respuestas
                          completados o fallidos. Un valor de 100 no indica que
                          los análisis posteriores estén listos.
                        minimum: 0
                        maximum: 100
                    required:
                      - pending
                      - processing
                      - completed
                      - failed
                      - total
                      - percentage
                  saved_response_progress:
                    type: object
                    nullable: true
                    description: >-
                      Recuentos en caché de respuestas conservadas, separados
                      del progreso de la cola de ejecución. Null indica que no
                      se registró un plan original de solicitudes. Comprueba
                      completed_count_observed_at: si falta la observación, el
                      recuento es desconocido, no cero. La recuperación puede
                      aumentarlo y la eliminación de respuestas reducirlo. Los
                      campos iniciales conservan la instantánea disponible en la
                      primera finalización.
                    properties:
                      planned_count:
                        type: integer
                        minimum: 0
                      expected_count:
                        type: integer
                        minimum: 0
                        nullable: true
                        description: >-
                          Todas las solicitudes base planificadas más las
                          variantes de consultas realmente generadas, fijadas
                          cuando termina el llenado original. Es menor que
                          planned_count si se generaron menos variantes de las
                          previstas. Null significa que el llenado no terminó;
                          cero, una ejecución vacía medida.
                      completed_count:
                        type: integer
                        minimum: 0
                        description: >-
                          Instantánea aproximada de las respuestas guardadas que
                          se conservan, incluidas las recuperadas y los
                          resultados tardíos aceptados. Solo se mide cuando está
                          presente completed_count_observed_at.
                      completed_count_observed_at:
                        type: string
                        nullable: true
                        description: >-
                          Marca de tiempo de observación del recuento. Null o
                          ausente significa desconocida. Los recuentos pueden
                          quedar desactualizados si falla la actualización;
                          consultar el estado nunca inicia un recuento nuevo.
                      population_completed_at:
                        type: string
                        nullable: true
                        description: >-
                          Marca de tiempo original de finalización del llenado.
                          La carga retroactiva nunca sustituye este límite.
                      initial_completed_count:
                        type: integer
                        minimum: 0
                        nullable: true
                        description: >-
                          Último recuento observado, fijado al alcanzarse el
                          primer resultado definitivo. Null si no se ha medido
                          el llenado o la instantánea del recuento. No es un
                          recuento exacto al finalizar.
                      initial_completed_count_observed_at:
                        type: string
                        nullable: true
                        description: >-
                          Momento de observación del recuento inicial fijado.
                          Puede ser anterior a initial_terminal_at.
                      initial_status:
                        type: string
                        enum:
                          - completed
                          - failed
                          - cancelled
                        nullable: true
                      initial_terminal_at:
                        type: string
                        nullable: true
                    required:
                      - planned_count
                      - expected_count
                      - completed_count
                      - population_completed_at
                      - initial_completed_count
                      - initial_status
                      - initial_terminal_at
                required:
                  - state
                  - workflow_id
                  - config
                  - progress
                  - saved_response_progress
        '400':
          description: 'Solicitud incorrecta: parámetros no válidos'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: 'Sin autorización: falta la clave de API o no es válida'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: 'Acceso denegado: no tienes acceso a este sitio web'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: >-
            Demasiadas solicitudes: se ha superado el límite. Vuelve a
            intentarlo tras una breve pausa.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Error interno del servidor
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Error:
      type: object
      description: Objeto de respuesta de error
      required:
        - error
      properties:
        error:
          type: string
          description: Mensaje de error que describe qué ha fallado
          example: Unauthorized
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Clave de API para autenticarse. Puedes crear una
        [aquí](https://app.athenahq.ai/organization?tab=api).

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.