Skip to content

Visibility

The Visibility component lets a single page serve two audiences: humans reading on the web and AI agents processing the Markdown output. Content marked for="humans" appears on the rendered page but is excluded from Markdown exports. Content marked for="agents" is hidden on the web but included in Markdown.

This means you can write conversational, UI-centric instructions for humans and structured, machine-readable instructions for AI — without maintaining two separate pages.

Mintlify serves every page at two URLs:

  • https://docs.example.com/page — the rendered site, for humans
  • https://docs.example.com/page.md — the raw Markdown, for AI agents

Visibility controls what appears at each URL.

Navigate to [dashboard.example.com](https://dashboard.example.com) and sign in.
Go to **Settings → API Keys** and click **New key**.
To authenticate, send a POST request to `/v1/auth/token` with the user's
email and password in the request body. The response includes a bearer token
valid for 24 hours. Pass this token as `Authorization: Bearer <token>` on
all subsequent requests.

Human readers see the step-by-step UI walkthrough. AI agents processing the Markdown get the direct API instructions instead.

  • "humans" — visible on the rendered web page, excluded from .md export - "agents" — hidden on the rendered web page, included in .md export

Show UI screenshots and button clicks to humans. Give agents the equivalent API calls.

Show a visual settings panel to humans. Give agents the equivalent JSON or CLI flags.

Show a friendly explanation to humans. Give agents structured error codes and remediation steps.

Include rich diagrams and narrative for humans. Provide a concise structured summary for agents.

Visibility and Prompt complement each other well. Use Visibility to give agents structured context, then use Prompt to give human readers a prompt they can use to ask an AI about that same content.

## Authentication schema
- Method: Bearer token
- Header: `Authorization: Bearer <token>`
- Token TTL: 86400 seconds
- Refresh endpoint: POST /v1/auth/refresh
Explain how authentication works in this API and show me example code for getting a token and
making an authenticated request.