> ## 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. # Obtenir les prompts > Renvoie tous les prompts du site, avec filtrage facultatif par statut (active ou paused). Inclut notamment volume de recherche mensuel et valeur totale. ## OpenAPI ````yaml fr/api-reference/openapi.json get /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: get: tags: - Basics summary: Obtenir les prompts description: >- Renvoie tous les prompts du site, avec filtrage facultatif par statut (active ou paused). Inclut notamment volume de recherche mensuel et valeur totale. operationId: getPrompts parameters: - name: website_id in: query description: ID du site dont récupérer les prompts required: true schema: type: string format: uuid - name: status in: query description: >- Filtrer les prompts par statut. Si omis, renvoie les prompts actifs et en pause. required: false schema: type: string enum: - active - paused - name: prompt_tags in: query description: >- Filtre par étiquette. Fournissez un ou plusieurs ID d’étiquettes (UUID). Sans champ, aucun filtre d’étiquette. `prompt_tags_operator` contrôle les correspondances multiples. Tous les ID doivent appartenir au même site que `website_id`, sinon `403`. required: false schema: type: array items: type: string format: uuid - name: prompt_tags_operator in: query description: >- Mode de combinaison du filtre `prompt_tags`. `is_any_of` (par défaut) renvoie les prompts portant au moins un des tags fournis ; `has_all_of` renvoie uniquement ceux portant tous les tags fournis. Ignoré lorsque `prompt_tags` est omis. required: false schema: type: string enum: - is_any_of - has_all_of responses: '200': description: Réponse réussie avec la liste des prompts content: application/json: schema: type: object properties: prompts: type: array items: $ref: '#/components/schemas/Prompt' required: - prompts '400': description: Requête incorrecte — paramètres invalides content: application/json: schema: $ref: '#/components/schemas/Error' examples: missing_website_id: value: error: website_id is required invalid_status: value: error: status must be 'active' or 'paused' '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' example: error: Unauthorized access to this website '429': description: Trop de requêtes — limite dépassée. Réessayez après un court délai. content: application/json: schema: $ref: '#/components/schemas/Error' '500': description: Erreur interne du serveur content: application/json: schema: $ref: '#/components/schemas/Error' security: - apiKey: [] components: schemas: Prompt: type: object description: Ressource de prompt pour la génération de contenu IA required: - id - prompt - status - country - countries - tags - prompt_type properties: id: type: string format: uuid description: Identifiant unique du prompt example: 123e4567-e89b-12d3-a456-426614174000 prompt: type: string description: Texte du prompt de génération de contenu example: How to optimize website performance topic_name: type: string nullable: true description: Nom de la catégorie de sujet du prompt example: Web Development current_monthly_searches: type: integer description: >- Volume de recherche mensuel estimé pour ce prompt. Le fournisseur ne mesure le volume qu’au-dessus d’un seuil d’environ 100/mois ; les prompts sous ce seuil sont renvoyés avec la valeur 100. example: 5400 current_total_value: type: number nullable: true description: Valeur mensuelle totale estimée du prompt example: 1250.5 status: type: string enum: - active - paused description: Statut actuel du prompt example: active country: type: string deprecated: true description: >- Obsolète. Utilisez `countries`. Renvoie le pays principal s’il est défini, sinon le premier par ordre alphabétique. Sans pays, utilise `"United States"`. example: United States countries: type: array description: >- Tous les pays cibles du prompt. Le principal d’abord, puis les autres par ordre alphabétique. Vide sans pays attribué. items: type: object required: - country - is_primary properties: country: type: string description: Nom du pays example: United States is_primary: type: boolean description: >- Indique le pays principal du prompt. Au maximum un pays principal par prompt. example: true example: - country: United States is_primary: true - country: Canada is_primary: false tags: type: array description: >- Étiquettes attribuées, triées par nom sans tenir compte de la casse. Vide sans étiquette. Leurs ID s’utilisent dans `prompt_tags` ici ou `tag_ids` sur POST /api/v1/prompts. GET /api/v1/prompt-tags liste le catalogue complet du site. items: $ref: '#/components/schemas/PromptTag' example: - id: 223e4567-e89b-12d3-a456-426614174111 name: Caption Phones prompt_type: type: string enum: - branded - non_branded nullable: true description: >- Indique si Athena classe le prompt Avec marque ou Sans marque, séparément de `tags` réservé aux étiquettes personnalisées. Même valeurs que `prompt_type` des métriques ; `null` sans type. Pour définir, envoyez `type` sur POST /api/v1/prompts ou PATCH /api/v1/prompts/{prompt_id} : `high_intent` Avec marque, `discovery` Sans marque. example: non_branded Error: type: object description: Objet de réponse d’erreur required: - error properties: error: type: string description: Message expliquant l’erreur example: Unauthorized PromptTag: type: object description: Référence à une étiquette de prompt required: - id - name properties: id: type: string format: uuid description: Identifiant unique de l’étiquette example: 223e4567-e89b-12d3-a456-426614174111 name: type: string description: Nom de l’étiquette example: Caption Phones 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.