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

# Crear consultas

> Crea una o varias consultas en un sitio web. Devuelve sus ID. Antes de insertar, valida la compatibilidad entre la geografía de cada consulta (`countries` / `primary_country`) y sus `location_ids` asociados.



## OpenAPI

````yaml es/api-reference/openapi.json post /api/v1/prompts
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/prompts:
    post:
      tags:
        - Basics
      summary: Crear consultas
      description: >-
        Crea una o varias consultas en un sitio web. Devuelve sus ID. Antes de
        insertar, valida la compatibilidad entre la geografía de cada consulta
        (`countries` / `primary_country`) y sus `location_ids` asociados.
      operationId: createPrompts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - website_id
                - prompts
              properties:
                website_id:
                  type: string
                  format: uuid
                  description: Sitio web en el que se crearán las consultas.
                prompts:
                  type: array
                  minItems: 1
                  maxItems: 1000
                  items:
                    type: object
                    required:
                      - prompt
                    properties:
                      prompt:
                        type: string
                        description: >-
                          Texto de la consulta. Se eliminan los espacios de los
                          extremos; se rechaza si está vacío o solo contiene
                          espacios.
                        example: best project management software
                        maxLength: 2000
                      type:
                        type: string
                        enum:
                          - discovery
                          - high_intent
                        nullable: true
                        description: >-
                          Tipo de consulta. Si se omite o es null, se deduce del
                          texto.
                        example: discovery
                      volume:
                        type: string
                        nullable: true
                        description: Etiqueta de volumen de texto libre.
                        example: '1000'
                      current_monthly_searches:
                        type: integer
                        nullable: true
                        minimum: 0
                        maximum: 2147483647
                        description: >-
                          Búsquedas mensuales estimadas. Los valores decimales
                          se redondean a un entero; si están fuera del
                          intervalo, devuelve 400.
                        example: 5400
                      current_total_value:
                        type: integer
                        nullable: true
                        minimum: 0
                        description: >-
                          Valor mensual total estimado. Los valores decimales se
                          redondean a un entero.
                        example: 1250
                      topic_id:
                        type: string
                        format: uuid
                        nullable: true
                        description: Tema al que se asignará la consulta.
                      countries:
                        type: array
                        maxItems: 1000
                        nullable: true
                        items:
                          type: string
                        description: >-
                          Nombres de países admitidos (sin distinción entre
                          mayúsculas y minúsculas; se guardan como etiquetas
                          canónicas).
                        example:
                          - United States
                          - France
                      primary_country:
                        type: string
                        nullable: true
                        description: >-
                          País principal. Si `countries` no está vacío, debe ser
                          uno de sus valores.
                        example: United States
                      persona_ids:
                        type: array
                        maxItems: 1000
                        nullable: true
                        items:
                          type: string
                          format: uuid
                        description: IDs de los perfiles de audiencia que se asociarán.
                      location_ids:
                        type: array
                        maxItems: 1000
                        nullable: true
                        items:
                          type: string
                          format: uuid
                        description: >-
                          ID de ubicaciones que se asociarán. El país de una
                          ubicación debe ser compatible con los países de la
                          consulta.
                      tag_ids:
                        type: array
                        maxItems: 1000
                        nullable: true
                        items:
                          type: string
                          format: uuid
                        description: IDs de las etiquetas que se asignarán.
                      is_paused:
                        type: boolean
                        description: >-
                          Crea la consulta pausada (conserva el estado de pausa
                          al importar). Por defecto, activa.
                        default: false
                source:
                  type: string
                  enum:
                    - manual
                    - ai_generated
                    - bulk_upload
                  description: >-
                    Origen de la atribución (solo para acciones de servidor de
                    la interfaz; se ignora en llamadas con clave de API).
      responses:
        '201':
          description: Consultas creadas
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - count
                  - prompt_ids
                properties:
                  success:
                    type: boolean
                    example: true
                  count:
                    type: integer
                    example: 1
                  prompt_ids:
                    type: array
                    items:
                      type: string
                      format: uuid
        '400':
          description: 'Solicitud incorrecta: error de validación'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                blank_text:
                  value:
                    error: Prompt text is required
                unsupported_country:
                  value:
                    error: 'Unsupported country: Atlantis'
                primary_not_in_countries:
                  value:
                    error: Primary country must be one of the prompt's countries
                location_country_mismatch:
                  value:
                    error: >-
                      A prompt's countries must include each attached location's
                      country
        '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'
              examples:
                no_access:
                  value:
                    error: Unauthorized access to this website
        '429':
          description: >-
            Límite de solicitudes superado. La creación de consultas se limita a
            60 solicitudes por minuto y sitio web, independientemente del límite
            de API de la organización. Cada solicitud admite hasta 1.000
            consultas; los lotes permiten unas 60.000 consultas por minuto y
            sitio web.
          headers:
            retry-after:
              description: Número de segundos que debes esperar antes de reintentar
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Rate limit exceeded
                  retryAfterMs:
                    type: integer
                    description: Milisegundos que debes esperar antes de reintentar
                    example: 60000
        '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.