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

# Créer des prompts

> Crée un ou plusieurs prompts sur un site web. Renvoie les ID des prompts créés. La géographie de chaque prompt (`countries` / `primary_country`) et les éventuels `location_ids` associés sont validés pour vérifier leur compatibilité avant l’insertion.



## OpenAPI

````yaml fr/api-reference/openapi.json post /api/v1/prompts
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/prompts:
    post:
      tags:
        - Basics
      summary: Créer des prompts
      description: >-
        Crée un ou plusieurs prompts sur un site web. Renvoie les ID des prompts
        créés. La géographie de chaque prompt (`countries` / `primary_country`)
        et les éventuels `location_ids` associés sont validés pour vérifier leur
        compatibilité avant l’insertion.
      operationId: createPrompts
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - website_id
                - prompts
              properties:
                website_id:
                  type: string
                  format: uuid
                  description: Site sur lequel créer les prompts.
                prompts:
                  type: array
                  minItems: 1
                  maxItems: 1000
                  items:
                    type: object
                    required:
                      - prompt
                    properties:
                      prompt:
                        type: string
                        description: >-
                          Texte du prompt. Espaces périphériques retirés ; vide
                          ou espaces seuls refusés.
                        example: best project management software
                        maxLength: 2000
                      type:
                        type: string
                        enum:
                          - discovery
                          - high_intent
                        nullable: true
                        description: 'Type de prompt. Omis/null : déduit du texte.'
                        example: discovery
                      volume:
                        type: string
                        nullable: true
                        description: Libellé libre du volume.
                        example: '1000'
                      current_monthly_searches:
                        type: integer
                        nullable: true
                        minimum: 0
                        maximum: 2147483647
                        description: >-
                          Recherches mensuelles estimées. Valeur fractionnaire
                          arrondie à l’entier ; hors limites : 400.
                        example: 5400
                      current_total_value:
                        type: integer
                        nullable: true
                        minimum: 0
                        description: >-
                          Valeur mensuelle totale estimée. Les valeurs décimales
                          saisies sont arrondies à un entier.
                        example: 1250
                      topic_id:
                        type: string
                        format: uuid
                        nullable: true
                        description: Sujet auquel attribuer le prompt.
                      countries:
                        type: array
                        maxItems: 1000
                        nullable: true
                        items:
                          type: string
                        description: >-
                          Noms de pays pris en charge (insensibles à la casse ;
                          stockés sous forme de libellés canoniques).
                        example:
                          - United States
                          - France
                      primary_country:
                        type: string
                        nullable: true
                        description: >-
                          Pays principal. Si `countries` n’est pas vide, doit en
                          faire partie.
                        example: United States
                      persona_ids:
                        type: array
                        maxItems: 1000
                        nullable: true
                        items:
                          type: string
                          format: uuid
                        description: ID des personas à associer.
                      location_ids:
                        type: array
                        maxItems: 1000
                        nullable: true
                        items:
                          type: string
                          format: uuid
                        description: >-
                          ID des emplacements à associer. Leur pays doit être
                          compatible avec ceux du prompt.
                      tag_ids:
                        type: array
                        maxItems: 1000
                        nullable: true
                        items:
                          type: string
                          format: uuid
                        description: ID des tags à attribuer.
                      is_paused:
                        type: boolean
                        description: >-
                          Crée le prompt en pause, en conservant cet état à
                          l’import. Actif par défaut.
                        default: false
                source:
                  type: string
                  enum:
                    - manual
                    - ai_generated
                    - bulk_upload
                  description: >-
                    Source d’attribution, uniquement pour l’action serveur de
                    l’interface ; ignorée pour les clés API.
      responses:
        '201':
          description: Prompts créés
          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: Requête incorrecte — erreur de validation
          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: 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'
              examples:
                no_access:
                  value:
                    error: Unauthorized access to this website
        '429':
          description: >-
            Limite de débit dépassée. La création de prompts est limitée à 60
            requêtes par minute et par site web, indépendamment de la limite de
            débit de l’API au niveau de l’organisation. Chaque requête accepte
            jusqu’à 1 000 prompts ; le traitement par lots permet donc un débit
            effectif d’environ 60 000 prompts par minute et par site web.
          headers:
            retry-after:
              description: Secondes à attendre avant de réessayer
              schema:
                type: string
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Rate limit exceeded
                  retryAfterMs:
                    type: integer
                    description: Millisecondes à attendre avant de réessayer
                    example: 60000
        '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.