Cette page est cachée ! Elle n’apparaît pas dans la navigation de docs.json, vous ne pouvez donc y accéder que via son URL. Consultez Pages cachées pour en savoir plus.

​
Cas d’usage courants pour les pages cachées

Par défaut, les pages cachées sont accessibles publiquement, mais ne sont pas trouvables via la navigation. Si vous souhaitez restreindre l’accès à une page cachée, vous devez configurer l’authentification.
  • Documentation bêta : Informations pouvant être publiques, mais qui ne devraient pas être trouvables 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 pour obtenir du contexte. Utilisez des pages cachées pour du contexte non pertinent pour les utilisateurs, mais utile aux outils d’IA pour fournir des réponses plus précises.
  • Anciennes pages : 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 préproduction ou les processus de développement.

​
Exemples

​
Contexte IA

---
title: "Contexte pour la version de l’API"
description: "Cette page fournit un contexte aux outils d’IA répondant à des questions sur les versions de l’API"
---

Lorsqu’un utilisateur pose des questions sur les versions de l’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 à la 1.0.4.

​
Point de terminaison d’API interne

---
title: "Point de terminaison d’API interne"
description: "Cette page est une page caché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 et il ne doit jamais être utilisé en production.
</Warning>