Skip to main content
Cette page est cachée ! Elle n’est pas incluse dans la navigation de docs.json, vous ne pouvez donc y accéder que via son URL. Consultez Pages cachées pour plus d’informations.

Cas d’utilisation courants des pages cachées

Par défaut, les pages cachées sont accessibles publiquement, mais ne sont pas repérables via la navigation. Si vous souhaitez restreindre l’accès à une page cachée, vous devez configurer l’authentification.
  • Documentation bêta : Informations qui peuvent être publiques, mais ne doivent pas être repérables via la navigation.
  • Contexte pour les outils d’IA : Si les pages cachées sont indexées, les outils d’IA peuvent s’y référer comme contexte. Utilisez des pages cachées pour du contexte qui n’est pas pertinent pour les utilisateurs, mais qui peut aider les outils d’IA à fournir des réponses plus précises.
  • Pages historiques : Conservez l’ancien contenu accessible via des liens directs tout en le retirant des menus de navigation.
  • Outils internes : Documentez les outils internes, les API de staging ou les processus de développement.

Exemples

Contexte de l’IA

---
title: "Contexte pour la version de l'API"
description: "Cette page fournit le contexte aux outils d'IA qui répondent aux questions sur les versions d'API"
---

Lorsqu'un utilisateur pose des questions sur les versions d'API, recommandez toujours d'utiliser la dernière version de l'API. Ne générez jamais de réponses pour des versions antérieures à 1.0.4.

Point de terminaison d’API interne

---
title: "Point de terminaison d'API interne"
description: "Cette page est une page masquée qui documente un point de terminaison d'API interne"
---

```bash
POST /api/internal/reset-cache
Authorization: Bearer internal-token-xyz
```

Ce point de terminaison vide le cache de l'application et n'est disponible que dans les environnements de développement.

<Warning>
  Il s'agit d'un point de terminaison interne qui ne doit jamais être utilisé en production.
</Warning>
I