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

# Obtenir le statut de collecte des réponses

> Renvoie l’état complet et la progression de la file de réponses d’une exécution de collecte en continu d’un site web. Indique la dernière exécution par défaut ; transmettez `workflow_id` pour en lire une précise. La progression mesure uniquement la collecte des réponses ; `state` peut donc rester `running` lorsque `progress.percentage` atteint 100 pendant que l’analyse en aval se termine. Seul `state: "completed"` indique que toute l’exécution, y compris l’analyse en aval, est terminée. `saved_response_progress` compte séparément les réponses enregistrées distinctes par rapport à la demande initiale, avec un instantané immuable du premier résultat terminal. Si aucune exécution n’a été lancée, `state` est `idle` et les champs de configuration et progression valent zéro ou null.



## OpenAPI

````yaml fr/api-reference/openapi.json get /api/v1/response-streaming/status
openapi: 3.1.0
info:
  title: API AthenaHQ
  description: >-
    L’API AthenaHQ permet de gérer vos sites et prompts par programme pour
    l’optimisation de contenu par IA.
  version: 1.0.0
  contact:
    email: support@athenahq.ai
servers:
  - url: https://api.athenahq.ai
    description: Serveur de production
security:
  - apiKey: []
tags:
  - name: Basics
    description: Opérations API principales pour gérer sites et prompts
  - name: Metrics
    description: Points de terminaison de métriques et analyses de visibilité IA
  - name: Billing
    description: Points de facturation et crédits pour gérer la consommation
  - name: Team Management
    description: Points de terminaison de gestion des membres et invitations
  - name: Groups
    description: Points de terminaison de gestion des groupes de sites
  - name: Content
    description: >-
      Points de terminaison Content Hub : onglets, URL suivies et détail des
      prompts par URL.
  - name: Pitch Workspace
    description: >-
      Points de terminaison des rapports Pitch Workspace : exécutions à
      l’échelle de l’organisation avec concurrents, prompts, attributs et
      métriques agrégées.
  - name: Knowledge Base
    description: >-
      Endpoints de lecture de la base de connaissances de la marque — faits
      approuvés et piliers qui les organisent.
paths:
  /api/v1/response-streaming/status:
    get:
      tags:
        - Basics
      summary: Obtenir le statut de collecte des réponses
      description: >-
        Renvoie l’état complet et la progression de la file de réponses d’une
        exécution de collecte en continu d’un site web. Indique la dernière
        exécution par défaut ; transmettez `workflow_id` pour en lire une
        précise. La progression mesure uniquement la collecte des réponses ;
        `state` peut donc rester `running` lorsque `progress.percentage` atteint
        100 pendant que l’analyse en aval se termine. Seul `state: "completed"`
        indique que toute l’exécution, y compris l’analyse en aval, est
        terminée. `saved_response_progress` compte séparément les réponses
        enregistrées distinctes par rapport à la demande initiale, avec un
        instantané immuable du premier résultat terminal. Si aucune exécution
        n’a été lancée, `state` est `idle` et les champs de configuration et
        progression valent zéro ou null.
      operationId: getResponseStreamingStatus
      parameters:
        - name: website_id
          in: query
          required: true
          description: ID du site web dont lire le statut d’exécution.
          schema:
            type: string
            format: uuid
        - name: workflow_id
          in: query
          required: false
          description: Lit une exécution précise plutôt que la dernière.
          schema:
            type: string
      responses:
        '200':
          description: État et progression de l’exécution actuelle
          content:
            application/json:
              schema:
                type: object
                properties:
                  state:
                    type: string
                    description: >-
                      État de l’exécution complète. Seul `completed` indique que
                      toute l’exécution, y compris l’analyse en aval, est
                      terminée. `running` peut coexister avec une progression
                      des réponses de 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: >-
                      Motif de fin d’une exécution `failed` ou `cancelled`.
                      `credits_exhausted` : solde épuisé. `credits_paused` :
                      allocation suspendue par le partenaire.
                      `subscription_inactive`, `organization_deleted`.
                      `entitlement_unreadable` : facturation illisible pendant
                      l’exécution, réponses en attente reprises par réanalyse.
                      `cancelled_by_user`. `responses_failed` : collecte
                      terminée avec des échecs. `items_stuck`,
                      `attribute_extraction_failed`, `workflow_error`, `stale`.
                      Null pendant l’exécution, pour les réussites et les
                      exécutions antérieures au champ.
                    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: >-
                      Mesure uniquement la collecte. Ces compteurs de file
                      n’indiquent pas la disponibilité des analyses en aval.
                    properties:
                      pending:
                        type: integer
                      processing:
                        type: integer
                      completed:
                        type: integer
                      failed:
                        type: integer
                      total:
                        type: integer
                      percentage:
                        type: number
                        description: >-
                          Pourcentage d’éléments de la file de réponses terminés
                          ou en échec. 100 ne signifie pas que les analyses en
                          aval sont prêtes.
                        minimum: 0
                        maximum: 100
                    required:
                      - pending
                      - processing
                      - completed
                      - failed
                      - total
                      - percentage
                  saved_response_progress:
                    type: object
                    nullable: true
                    description: >-
                      Comptes en cache des réponses conservées, distincts de la
                      file d’exécution. Null signifie absence de plan initial
                      enregistré. Vérifiez completed_count_observed_at :
                      observation absente signifie inconnu, pas zéro. La
                      récupération peut augmenter le compte, la suppression le
                      réduire. Les champs initiaux gardent l’instantané de
                      première finalisation.
                    properties:
                      planned_count:
                        type: integer
                        minimum: 0
                      expected_count:
                        type: integer
                        minimum: 0
                        nullable: true
                        description: >-
                          Toutes les requêtes de base prévues et variantes
                          réellement générées, figées à la fin de la population
                          initiale. Inférieur à planned_count si la génération
                          n’a pas atteint la cible. Null si population jamais
                          terminée ; zéro si exécution vide mesurée.
                      completed_count:
                        type: integer
                        minimum: 0
                        description: >-
                          Instantané au mieux des réponses enregistrées
                          conservées, y compris récupération et résultats
                          tardifs acceptés. Mesuré uniquement si
                          completed_count_observed_at est présent.
                      completed_count_observed_at:
                        type: string
                        nullable: true
                        description: >-
                          Horodatage d’observation du compte. Null ou absent
                          signifie inconnu. Les comptes peuvent rester obsolètes
                          en cas d’échec d’actualisation ; les lectures de
                          statut ne déclenchent jamais un recomptage.
                      population_completed_at:
                        type: string
                        nullable: true
                        description: >-
                          Horodatage initial de fin de population. La réanalyse
                          ne remplace jamais cette borne.
                      initial_completed_count:
                        type: integer
                        minimum: 0
                        nullable: true
                        description: >-
                          Dernier compte observé figé au premier résultat
                          terminal. Null si population ou instantané non mesuré.
                          Ce n’est pas un compte exact à la finalisation.
                      initial_completed_count_observed_at:
                        type: string
                        nullable: true
                        description: >-
                          Date d’observation du compte initial figé, pouvant
                          précéder 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: Requête incorrecte — paramètres invalides
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Non autorisé — clé API invalide ou absente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Interdit — vous n’avez pas accès à ce site
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Trop de requêtes — limite dépassée. Réessayez après un court délai.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Erreur interne du serveur
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    Error:
      type: object
      description: Objet de réponse d’erreur
      required:
        - error
      properties:
        error:
          type: string
          description: Message expliquant l’erreur
          example: Unauthorized
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Clé API d’authentification. Créez-en une
        [ici](https://app.athenahq.ai/organization?tab=api).

````

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