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

# Provisionner un site

> Crée un site entièrement configuré en un appel, sans assistant initial. Configure éventuellement concurrents, prompts et planification de traitement. Clé globale requise. Les **intégrations partenaires** peuvent associer leur identifiant avec `external_id`. La création réussie provisionne aussi la planification Par défaut dans la même transaction.

> **Bêta** : ce point est en bêta ; les schémas peuvent évoluer. Les motifs de suivi conservent hôte soumis, casse du chemin et contraintes de requête. Les domaines apex incluent leur forme www ; les hôtes www explicites restent distincts. Les chemins correspondent par sections délimitées par des barres obliques.



## OpenAPI

````yaml fr/api-reference/openapi.json post /api/v1/websites/provision
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/websites/provision:
    post:
      tags:
        - Basics
      summary: Provisionner un site
      description: >-
        Crée un site entièrement configuré en un appel, sans assistant initial.
        Configure éventuellement concurrents, prompts et planification de
        traitement. Clé globale requise. Les **intégrations partenaires**
        peuvent associer leur identifiant avec `external_id`. La création
        réussie provisionne aussi la planification Par défaut dans la même
        transaction.


        > **Bêta** : ce point est en bêta ; les schémas peuvent évoluer. Les
        motifs de suivi conservent hôte soumis, casse du chemin et contraintes
        de requête. Les domaines apex incluent leur forme www ; les hôtes www
        explicites restent distincts. Les chemins correspondent par sections
        délimitées par des barres obliques.
      operationId: provisionWebsite
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ProvisionWebsiteRequest'
      responses:
        '201':
          description: Site web provisionné
          content:
            application/json:
              schema:
                type: object
                properties:
                  website:
                    $ref: '#/components/schemas/ProvisionedWebsite'
                  billingEntityCreated:
                    type: boolean
                    description: >-
                      Indique si l’entité de facturation existe après
                      provisionnement. Si faux, sa création a échoué même après
                      une nouvelle tentative : le site existe mais n’a pas de
                      crédits, et leur définition échoue avec un statut 400
                      jusqu’à réparation. Contactez alors l’assistance AthenaHQ.
                required:
                  - website
                  - billingEntityCreated
              example:
                website:
                  id: 123e4567-e89b-12d3-a456-426614174000
                  url: acme.com
                  name: Acme Corp
                  orgId: 987e6543-e21b-12d3-a456-426614174000
                  promptCount: 2
                  competitorCount: 1
                  hasSchedule: true
                billingEntityCreated: true
        '400':
          description: Requête incorrecte — paramètres invalides
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalid_json:
                  value:
                    error: Invalid JSON body
                missing_url:
                  value:
                    error: 'url: String must contain at least 1 character(s)'
                missing_name:
                  value:
                    error: 'name: String must contain at least 1 character(s)'
                invalid_prompt_type:
                  value:
                    error: >-
                      prompts.0.type: Invalid enum value. Expected 'discovery' |
                      'high_intent', received 'invalid'
                email_as_url:
                  value:
                    error: 'url: Enter your website address, not an email address.'
        '401':
          description: Non autorisé — clé API invalide ou absente
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: >-
            Interdit - Nécessite une clé API globale ou (champ réservé aux
            partenaires) la clé n’a pas l’identité partenaire pour un
            `external_id`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                global_required:
                  summary: Clé API globale requise
                  value:
                    error: 'Forbidden: global API key required'
                partner_required:
                  summary: Clé API partenaire requise pour external_id
                  value:
                    error: 'Forbidden: partner API key required'
        '409':
          description: >-
            Conflit — partenaires uniquement : le `external_id` fourni est déjà
            associé à un autre site.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ExternalIdConflictError'
              examples:
                external_id_conflict:
                  summary: external_id partenaire déjà associé
                  value:
                    error: external_id_conflict
                    message: external_id ws_a7f3b2c9 is already mapped to a website
                    existing:
                      id: 123e4567-e89b-12d3-a456-426614174000
                      externalId: ws_a7f3b2c9
        '500':
          description: Erreur interne du serveur
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    ProvisionWebsiteRequest:
      type: object
      description: Corps de provisionnement d’un site entièrement configuré
      required:
        - url
        - name
      properties:
        url:
          type: string
          description: >-
            URL du site. Le protocole (https://) est retiré automatiquement. Les
            e-mails et URL avec nom d’utilisateur (`name@example.com`) sont
            refusés avec `400`.
          example: acme.com
          maxLength: 2048
        name:
          type: string
          description: Nom de marque
          example: Acme Corp
          maxLength: 255
        description:
          type: string
          description: Description de marque
          default: ''
          example: Enterprise widgets company
        country:
          type: string
          description: Pays de base du site web
          default: United States
          example: United States
        language:
          type: string
          description: >-
            Langue par défaut, déduite du pays si omise (Allemagne → allemand,
            par exemple), puis anglais en repli.
          example: English
        industry:
          type: string
          description: >-
            Catégorie sectorielle. Valeurs courantes : `SaaS & Software`,
            `E-commerce & Retail`, `Healthcare & Medical`, `Information
            Technology`, `Banking & Financial Services`, `Education &
            E-learning`, `Consulting`, `Manufacturing`, `Hospitality & Travel`,
            `Real Estate`, etc. Accepte toute chaîne.
          example: SaaS & Software
        identifiers:
          type: array
          items:
            type: string
            maxLength: 500
          description: >-
            Noms, alias et abréviations de marque pour détecter les mentions. Si
            vide, générés par IA lors du premier traitement.
          default: []
          example:
            - Acme
            - Acme Corp
          maxItems: 200
        competitors:
          type: array
          items:
            $ref: '#/components/schemas/CompetitorInput'
          description: >-
            Concurrents à suivre, dédupliqués par URL. L’URL du site lui-même et
            ses sous-chemins sont ignorés.
          default: []
          maxItems: 500
        prompts:
          type: array
          items:
            $ref: '#/components/schemas/PromptInput'
          description: >-
            Prompts (requêtes) à suivre sur les modèles IA, dédupliqués par
            texte.
          default: []
          maxItems: 10000
        schedule:
          $ref: '#/components/schemas/ScheduleInput'
        external_id:
          type: string
          minLength: 1
          description: >-
            **Partenaires uniquement.** Un identifiant de votre propre système à
            associer à ce site Athena. Accepté uniquement avec une clé API d’une
            organisation marquée comme partenaire. L’envoi de ce champ par un
            client direct renvoie `403 Forbidden`. Doit être unique par type de
            ressource dans votre organisation — les doublons renvoient `409`
            avec la ressource existante dans la charge utile.
          example: ws_a7f3b2c9
    ProvisionedWebsite:
      type: object
      description: Réponse du site provisionné
      required:
        - id
        - url
        - name
        - orgId
        - promptCount
        - competitorCount
        - hasSchedule
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique du site
          example: 123e4567-e89b-12d3-a456-426614174000
        url:
          type: string
          description: URL du site nettoyée, sans protocole
          example: acme.com
        name:
          type: string
          description: Nom de marque
          example: Acme Corp
        orgId:
          type: string
          format: uuid
          description: ID de l’organisation du site
          example: 987e6543-e21b-12d3-a456-426614174000
        promptCount:
          type: integer
          description: Nombre de prompts créés
          example: 2
        competitorCount:
          type: integer
          description: Nombre de concurrents créés
          example: 1
        hasSchedule:
          type: boolean
          description: Indique si une planification de traitement a été configurée
          example: true
        externalId:
          type: string
          nullable: true
          description: >-
            **Partenaires uniquement.** Reprend le `external_id` de la requête
            de provisionnement ou `null` s’il n’a pas été fourni. Présent
            uniquement pour les clés partenaires ; omis pour les clients
            directs.
          example: ws_a7f3b2c9
    Error:
      type: object
      description: Objet de réponse d’erreur
      required:
        - error
      properties:
        error:
          type: string
          description: Message expliquant l’erreur
          example: Unauthorized
    ExternalIdConflictError:
      type: object
      description: >-
        Renvoyé si un partenaire définit un `external_id` déjà associé à une
        autre ressource du même type dans l’organisation. `existing` identifie
        la ressource détentrice pour récupérer une relance ou rapprocher les
        associations.
      required:
        - error
        - message
        - existing
      properties:
        error:
          type: string
          enum:
            - external_id_conflict
          description: Code d’erreur machine, toujours `external_id_conflict`.
          example: external_id_conflict
        message:
          type: string
          description: Explication lisible du conflit.
          example: external_id ws_a7f3b2c9 is already mapped to a website
        existing:
          type: object
          required:
            - id
            - externalId
          description: Ressource détenant actuellement le `external_id` en conflit.
          properties:
            id:
              type: string
              format: uuid
              description: ID Athena de la ressource existante.
              example: 123e4567-e89b-12d3-a456-426614174000
            externalId:
              type: string
              description: external_id déjà associé.
              example: ws_a7f3b2c9
    CompetitorInput:
      type: object
      description: Concurrent à suivre
      required:
        - name
        - url
      properties:
        name:
          type: string
          description: Nom du concurrent
          example: WidgetCo
          maxLength: 255
        url:
          type: string
          description: URL du site concurrent
          example: widgetco.com
          maxLength: 2048
        identifiers:
          type: array
          items:
            type: string
            maxLength: 500
          description: >-
            Alias supplémentaires au nom et domaine automatiquement inclus. Si
            vide, génération automatique lors du premier traitement.
          default: []
          example:
            - WidgetCo
          maxItems: 200
    PromptInput:
      type: object
      description: Prompt (requête) à suivre sur les modèles IA
      required:
        - text
      properties:
        text:
          type: string
          description: Texte du prompt ou de la requête à envoyer aux modèles d’IA
          example: best widget software
          maxLength: 2000
        topic:
          type: string
          description: >-
            Nom du sujet de regroupement, créé si inexistant. Omettez pour
            laisser le prompt non classé.
          example: Products
        type:
          type: string
          enum:
            - discovery
            - high_intent
          description: >-
            Type de prompt : `discovery` pour les recherches informationnelles,
            `high_intent` pour l’intention d’achat.
          default: discovery
          example: discovery
    ScheduleInput:
      type: object
      description: >-
        Configuration de planification du traitement. Si entièrement omise,
        aucune planification créée ; l’utilisateur peut la configurer dans
        l’interface. Tous ses champs sont facultatifs avec des valeurs par
        défaut adaptées.
      properties:
        days:
          type: object
          description: >-
            Jours du traitement : noms de jours (Monday–Sunday) comme clés,
            booléens comme valeurs.
          additionalProperties:
            type: boolean
          default:
            Monday: true
            Tuesday: true
            Wednesday: true
            Thursday: true
            Friday: true
            Saturday: true
            Sunday: true
          example:
            Monday: true
            Wednesday: true
            Friday: true
        models:
          type: object
          description: >-
            Modèles à interroger : `chatgpt`, `ai_overview`, `perplexity`,
            `gemini`, `copilot`, `grok`, `ai_mode`, `claude`.
          additionalProperties:
            type: boolean
          default:
            chatgpt: true
            gemini: true
            copilot: true
            perplexity: true
            ai_overview: true
          example:
            chatgpt: true
            gemini: true
            perplexity: true
        isActive:
          type: boolean
          description: Indique l’activation des exécutions automatiques planifiées
          default: true
        processingHour:
          type: integer
          minimum: 0
          maximum: 23
          description: >-
            Heure UTC de déclenchement du traitement programmé. Si omise,
            attribuée aléatoirement entre 0 et 17.
  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.