> ## 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 un groupe

> Crée un groupe avec ses sites. Clé API globale requise. Les **intégrations partenaires** peuvent inclure `external_id` pour associer leur identifiant au nouveau groupe Athena.



## OpenAPI

````yaml fr/api-reference/openapi.json post /api/v1/groups
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/groups:
    post:
      tags:
        - Groups
      summary: Créer un groupe
      description: >-
        Crée un groupe avec ses sites. Clé API globale requise. Les
        **intégrations partenaires** peuvent inclure `external_id` pour associer
        leur identifiant au nouveau groupe Athena.
      operationId: createGroup
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateGroupRequest'
      responses:
        '201':
          description: Groupe créé avec succès
          content:
            application/json:
              schema:
                type: object
                properties:
                  group:
                    $ref: '#/components/schemas/CreatedGroup'
                  billingEntityCreated:
                    type: boolean
                    description: >-
                      Présent uniquement avec billing_enabled demandé :
                      existence de l’entité après provisionnement. Si faux,
                      création échouée malgré relance ; définir les crédits du
                      groupe renvoie 400 jusqu’à réparation par PATCH
                      /api/v1/groups/{group_id} avec billing_enabled: true.
                required:
                  - group
        '400':
          description: >-
            Requête incorrecte - Erreur de validation ou ID de sites web
            invalides
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                invalid_website_ids:
                  value:
                    error: >-
                      Website IDs not found in organization:
                      123e4567-e89b-12d3-a456-426614174000
                missing_name:
                  value:
                    error: Group name is required
                missing_websites:
                  value:
                    error: At least one website_id is required
        '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 : `external_id` est déjà associé à
            un autre groupe.
          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 acct_9e4c1b8d is already mapped to a group
                    existing:
                      id: 123e4567-e89b-12d3-a456-426614174000
                      externalId: acct_9e4c1b8d
        '500':
          description: Erreur interne du serveur
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      security:
        - apiKey: []
components:
  schemas:
    CreateGroupRequest:
      type: object
      description: Corps de création d’un groupe
      required:
        - name
        - website_ids
      properties:
        name:
          type: string
          minLength: 1
          description: Nom du groupe.
          example: Enterprise Clients
        website_ids:
          type: array
          minItems: 1
          items:
            type: string
            format: uuid
          description: >-
            ID des sites du groupe. Tous doivent appartenir à votre
            organisation. Les doublons sont réduits à une appartenance.
          example:
            - 123e4567-e89b-12d3-a456-426614174000
            - 987e6543-e21b-12d3-a456-426614174000
        billing_enabled:
          type: boolean
          default: false
          description: Indique s’il faut activer la facturation pour ce groupe
          example: false
        external_id:
          type: string
          minLength: 1
          description: >-
            **Partenaires uniquement.** Identifiant de votre système à associer
            au groupe Athena. Clé d’organisation partenaire requise ; client
            direct : `403 Forbidden`. Unique par type de ressource ; doublon :
            `409` avec la ressource existante.
          example: acct_9e4c1b8d
    CreatedGroup:
      type: object
      description: Nouvelle ressource de groupe
      required:
        - id
        - name
        - orgId
        - billingEnabled
        - websiteIds
        - createdAt
      properties:
        id:
          type: string
          format: uuid
          description: Identifiant unique du groupe
          example: 123e4567-e89b-12d3-a456-426614174000
        name:
          type: string
          description: Nom du groupe
          example: Enterprise Clients
        orgId:
          type: string
          format: uuid
          description: ID de l’organisation du groupe
          example: 987e6543-e21b-12d3-a456-426614174000
        billingEnabled:
          type: boolean
          description: Indique si la facturation est activée pour ce groupe
          example: false
        websiteIds:
          type: array
          items:
            type: string
            format: uuid
          description: ID des sites associés au groupe
          example:
            - 123e4567-e89b-12d3-a456-426614174000
        createdAt:
          type: string
          format: date-time
          description: Horodatage de création du groupe (UTC)
          example: '2024-06-15T10:30:00.000Z'
        externalId:
          type: string
          nullable: true
          description: >-
            **Partenaires uniquement.** Renvoie le `external_id` de la requête
            de création s’il a été fourni ou `null` sinon. Présent uniquement
            dans les réponses aux clés API partenaires — les réponses aux
            clients directs omettent ce champ.
          example: acct_9e4c1b8d
    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
  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.