> ## 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 rapport de proposition

> Génère un rapport Pitch Workspace depuis une URL publique. Exige une clé globale, l’accès Pitch Workspace et un quota disponible. Renvoie un ID durable pendant la recherche. Interrogez GET /api/v1/pitches/{pitch_id} jusqu’à pitch.status completed ou failed. L’URL est accessible à toute personne la possédant. Chaque requête admise consomme une proposition, même si la génération échoue. Réessayer avec même organisation, Idempotency-Key et entrée normalisée réutilise la proposition ; entrée différente : 409. Une nouvelle clé demande explicitement un nouvel instantané. Aucun e-mail envoyé.



## OpenAPI

````yaml fr/api-reference/openapi.json post /api/v1/pitches
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/pitches:
    post:
      tags:
        - Pitch Workspace
      summary: Créer un rapport de proposition
      description: >-
        Génère un rapport Pitch Workspace depuis une URL publique. Exige une clé
        globale, l’accès Pitch Workspace et un quota disponible. Renvoie un ID
        durable pendant la recherche. Interrogez GET /api/v1/pitches/{pitch_id}
        jusqu’à pitch.status completed ou failed. L’URL est accessible à toute
        personne la possédant. Chaque requête admise consomme une proposition,
        même si la génération échoue. Réessayer avec même organisation,
        Idempotency-Key et entrée normalisée réutilise la proposition ; entrée
        différente : 409. Une nouvelle clé demande explicitement un nouvel
        instantané. Aucun e-mail envoyé.
      operationId: createPitch
      parameters:
        - name: Idempotency-Key
          in: header
          required: true
          schema:
            type: string
            minLength: 1
            maxLength: 128
          description: >-
            Identifiant stable d’une requête logique. Conservez-le lors des
            relances.
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              additionalProperties: false
              required:
                - website_url
              properties:
                website_url:
                  type: string
                  maxLength: 2000
                  example: https://example.com
                country:
                  type: string
                  maxLength: 100
                  default: United States
                language:
                  type: string
                  maxLength: 100
                  default: English
      responses:
        '202':
          description: >-
            Accepté, ou résultat existant d’une relance idempotente. La
            génération peut prendre plusieurs minutes.
          content:
            application/json:
              schema:
                type: object
                required:
                  - pitch_id
                  - status
                  - report_url
                properties:
                  pitch_id:
                    type: string
                    format: uuid
                  status:
                    type: string
                    enum:
                      - processing
                      - completed
                      - failed
                  report_url:
                    type: string
                    format: uri
        '400':
          description: Corps ou URL invalide, ou Idempotency-Key manquante.
        '401':
          description: Clé API absente ou invalide.
        '403':
          description: Clé globale, droit Pitch Workspace ou quota de propositions requis.
        '404':
          description: Le rapport de cette requête a été supprimé.
        '409':
          description: Idempotency-Key déjà utilisée avec une entrée différente.
        '429':
          description: >-
            Limite de débit ou plafond de trois rapports simultanés dépassé.
            Respectez Retry-After.
        '500':
          description: >-
            L’admission n’a pas pu être confirmée. Réessayez rapidement avec la
            même Idempotency-Key ; contactez l’assistance si le problème
            persiste.
      security:
        - apiKey: []
components:
  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.