Audiences

Use audiences to filter the endpoints, schemas, and properties that are displayed in your API Reference.

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.