Esta página está oculta! Ela não está incluída na navegação do docs.json, então você só pode acessá-la pela URL. Consulte Páginas ocultas para mais informações.

​
Casos de uso comuns para páginas ocultas

Por padrão, as páginas ocultas são publicamente acessíveis, mas não podem ser encontradas pela navegação. Se você quiser restringir o acesso a uma página oculta, deve configurar a autenticação.
  • Documentação beta: Informações que podem ser públicas, mas não devem ser encontradas pela navegação.
  • Contexto para ferramentas de IA: Se as páginas ocultas forem indexadas, as ferramentas de IA poderão referenciá-las como contexto. Use páginas ocultas para conteúdo que não é relevante para os usuários, mas pode ajudar as ferramentas de IA a fornecer respostas mais precisas.
  • Páginas antigas: Mantenha conteúdo antigo acessível por links diretos, removendo-o dos menus de navegação.
  • Ferramentas internas: Documente ferramentas internas, APIs de staging ou processos de desenvolvimento.

​
Exemplos

​
Contexto de IA

---
title: "Contexto para versão da API"
description: "Esta página fornece contexto para ferramentas de IA que respondem a perguntas sobre versões da API"
---

Quando um usuário perguntar sobre versões da API, sempre recomende o uso da versão mais recente. Nunca gere respostas para versões anteriores à 1.0.4.

​
Endpoint interno da API

---
title: "Endpoint interno da API"
description: "Esta é uma página oculta que documenta um endpoint interno da API"
---

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

Este endpoint limpa o cache do aplicativo e está disponível apenas em ambientes de desenvolvimento.

<Warning>
  Este é um endpoint interno e nunca deve ser usado em produção.
</Warning>