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

# Iniciar obtención de respuestas

> Ejecuta consultas monitorizadas en proveedores externos de IA para recopilar respuestas nuevas de un sitio web. Envía el texto a los proveedores seleccionados, guarda sus respuestas en AthenaHQ y consume créditos de respuestas. Empieza inmediatamente; úsalo solo cuando lo solicite el usuario. Devuelve workflow_id; consulta GET /api/v1/response-streaming/status para ver el progreso. Requiere una clave de administrador del sitio.



## OpenAPI

````yaml es/api-reference/openapi.json post /api/v1/response-streaming/start
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/start:
    post:
      tags:
        - Basics
      summary: Iniciar obtención de respuestas
      description: >-
        Ejecuta consultas monitorizadas en proveedores externos de IA para
        recopilar respuestas nuevas de un sitio web. Envía el texto a los
        proveedores seleccionados, guarda sus respuestas en AthenaHQ y consume
        créditos de respuestas. Empieza inmediatamente; úsalo solo cuando lo
        solicite el usuario. Devuelve workflow_id; consulta GET
        /api/v1/response-streaming/status para ver el progreso. Requiere una
        clave de administrador del sitio.
      operationId: startResponseStreaming
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - website_id
              properties:
                website_id:
                  type: string
                  format: uuid
                  description: Sitio web en el que se obtendrán respuestas.
                schedule_id:
                  type: string
                  format: uuid
                  description: >-
                    UUID de la programación a la que se atribuirá la ejecución y
                    de la que se tomarán los selectores de consultas. Una
                    selección prompt_ids no vacía los sustituye. Omítelo para
                    atribuirla a la predeterminada y ejecutar todas las
                    consultas activas, salvo que se indique prompt_ids. Las
                    opciones explícitas de modelos, expansión, perfiles y
                    ubicaciones se aplican a esta ejecución. La programación
                    debe pertenecer al sitio y no estar archivada.
                prompt_ids:
                  type: array
                  items:
                    type: string
                    format: uuid
                  description: >-
                    UUID de consultas monitorizadas que se ejecutarán, entre 1 y
                    1.000. Si se indican, sustituyen a los selectores de la
                    programación. Omítelos para usar los de schedule_id, o todas
                    las consultas activas si también se omite schedule_id. Se
                    omiten las pausadas.
                selected_models:
                  type: object
                  additionalProperties:
                    type: boolean
                  description: >-
                    Mapa de ID de modelo a indicador de activación (p. ej., `{
                    "ai_overview": true, "ai_mode": false }`). ID: `chatgpt`,
                    `ai_overview` (Google AI Overviews; también acepta
                    `google_ai_overview`, su nombre en los filtros),
                    `perplexity`, `gemini`, `copilot`, `ai_mode`, `grok`,
                    `claude`, `deepseek`, `meta_ai`, `mistral`. Omítelo para
                    ejecutar todos los modelos activos; no es la selección
                    predeterminada guardada del panel. Un ID desconocido con
                    `true` devuelve 400, al igual que una selección explícita
                    sin modelos disponibles.
                prompt_variations:
                  type: integer
                  minimum: 0
                  maximum: 10
                  description: >-
                    Número de variantes parafraseadas que se generarán por
                    consulta (0–10).
                use_personas:
                  type: boolean
                  description: >-
                    Indica si las consultas se ejecutarán con los perfiles de
                    audiencia configurados.
                use_locations:
                  type: boolean
                  description: >-
                    Indica si las consultas se ejecutarán en las ubicaciones
                    configuradas del sitio web.
                only_locations:
                  type: boolean
                  description: >-
                    Si es true, omite la ejecución base (sin localización) y
                    ejecuta solo las variantes por ubicación. Requiere
                    `use_locations: true`: enviar `only_locations: true` sin
                    `use_locations: true` no encola nada (se omite la base y no
                    se añaden variantes), así que la ejecución termina sin
                    realizar operaciones.
      responses:
        '201':
          description: Ejecución iniciada
          content:
            application/json:
              schema:
                type: object
                properties:
                  workflow_id:
                    type: string
                  status:
                    type: string
                    enum:
                      - running
                required:
                  - workflow_id
                  - status
        '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: se requiere acceso de administrador a este sitio
            web
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: >-
            Conflicto: ya hay una ejecución de recopilación de respuestas en
            curso para este sitio web. Consulta GET
            /api/v1/response-streaming/status y reintenta cuando deje de estar
            `running`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                error: >-
                  A response-streaming run is already in progress for this
                  website
        '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.