For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Slack communityLog inBook a demo
  • Getting Started
    • Overview
    • Quickstart
    • Customer Showcase
  • Writing Content
    • Markdown
    • Visual Editor
    • Reusable Markdown
    • Custom React Components
      • Generate API Reference
      • SDK Snippets
      • HTTP Snippets
      • Endpoint Errors
      • Audiences
      • Customize API Reference Layout
      • Write Markdown in API Reference
      • Generate Webhook Reference
      • Multiple Server URLs
      • Generate WebSocket Reference
      • Generate OpenRPC Reference
    • Changelog
LogoLogo
Slack communityLog inBook a demo
API References

Audiences

Use audiences to filter the endpoints, schemas, and properties that are displayed in your API Reference.
Was this page helpful?
Previous

Customize API Reference layout

Next
Built with

Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include public and beta. You can configure audiences in both the OpenAPI Specification as well as the Fern Definition.

Once you’ve added audiences to your API Specification, you can filter to that audience by adding the audience property to the api object in your docs.yml navigation.

docs.yml
1navigation:
2  - api: API Reference
3    audiences:
4      - public

Here’s an example from Schematic in production.