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

# Lancer la collecte de réponses

> Exécute les prompts suivis auprès des fournisseurs d’IA externes pour collecter de nouvelles réponses pour un site web. Envoie les textes des prompts aux fournisseurs sélectionnés, stocke leurs réponses dans AthenaHQ et consomme des crédits de réponse. Démarre immédiatement ; utilisez uniquement pour une exécution demandée par l’utilisateur. Renvoie un workflow_id ; interrogez GET /api/v1/response-streaming/status pour suivre la progression. Nécessite une clé API d’administrateur du site web.



## OpenAPI

````yaml fr/api-reference/openapi.json post /api/v1/response-streaming/start
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/start:
    post:
      tags:
        - Basics
      summary: Lancer la collecte de réponses
      description: >-
        Exécute les prompts suivis auprès des fournisseurs d’IA externes pour
        collecter de nouvelles réponses pour un site web. Envoie les textes des
        prompts aux fournisseurs sélectionnés, stocke leurs réponses dans
        AthenaHQ et consomme des crédits de réponse. Démarre immédiatement ;
        utilisez uniquement pour une exécution demandée par l’utilisateur.
        Renvoie un workflow_id ; interrogez GET
        /api/v1/response-streaming/status pour suivre la progression. Nécessite
        une clé API d’administrateur du site web.
      operationId: startResponseStreaming
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - website_id
              properties:
                website_id:
                  type: string
                  format: uuid
                  description: >-
                    Site web pour lequel lancer la collecte de réponses en
                    continu.
                schedule_id:
                  type: string
                  format: uuid
                  description: >-
                    UUID de planification auquel attribuer l’exécution et dont
                    reprendre les sélecteurs. Une sélection prompt_ids non vide
                    prévaut. Omettre attribue à Par défaut et lance tous les
                    prompts actifs sauf prompt_ids fourni. Les choix explicites
                    de modèles, expansion, personas et emplacements s’appliquent
                    à cette exécution. La planification doit appartenir au site
                    et ne pas être archivée.
                prompt_ids:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: >-
                    UUID des prompts suivis à exécuter, de 1 à 1 000. Remplace
                    les sélecteurs de prompts de la programmation si fourni.
                    Omettez pour utiliser les sélecteurs de schedule_id ou tous
                    les prompts actifs si schedule_id est également omis. Les
                    prompts en pause sont ignorés.
                selected_models:
                  type: object
                  additionalProperties:
                    type: boolean
                  description: >-
                    Correspondance entre ID de modèle et indicateur d’activation
                    (ex. : `{ "ai_overview": true, "ai_mode": false }`). ID de
                    modèles : `chatgpt`, `ai_overview` (Google AI Overviews ;
                    `google_ai_overview`, son nom dans les filtres de modèles,
                    est également accepté), `perplexity`, `gemini`, `copilot`,
                    `ai_mode`, `grok`, `claude`, `deepseek`, `meta_ai`,
                    `mistral`. Omettez pour exécuter tous les modèles
                    actuellement actifs — il ne s’agit pas de la sélection par
                    défaut enregistrée dans le tableau de bord. Un ID défini sur
                    `true` ne désignant aucun modèle est rejeté avec 400, tout
                    comme une sélection explicite ne correspondant à aucun
                    modèle disponible.
                prompt_variations:
                  type: integer
                  minimum: 0
                  maximum: 10
                  description: Nombre de variantes reformulées par prompt à générer (0–10).
                use_personas:
                  type: boolean
                  description: >-
                    Indique si les prompts doivent utiliser les personas
                    configurés.
                use_locations:
                  type: boolean
                  description: >-
                    Indique s’il faut exécuter les prompts sur les emplacements
                    configurés du site.
                only_locations:
                  type: boolean
                  description: >-
                    Si vrai, ignore l’exécution de base non localisée et exécute
                    uniquement les variantes géographiques. Exige
                    `use_locations: true` : `only_locations: true` sans
                    `use_locations: true` ne met rien en file, car la base est
                    ignorée et aucune variante ajoutée ; l’exécution termine
                    sans action.
      responses:
        '201':
          description: Exécution démarrée
          content:
            application/json:
              schema:
                type: object
                properties:
                  workflow_id:
                    type: string
                  status:
                    type: string
                    enum:
                      - running
                required:
                  - workflow_id
                  - status
        '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 — accès administrateur au site requis
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            Conflit — collecte de réponses déjà en cours pour ce site.
            Interrogez GET /api/v1/response-streaming/status et réessayez
            lorsqu’elle n’est plus `running`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: >-
                  A response-streaming run is already in progress for this
                  website
        '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.