Use audiences to filter your API

Audiences are a useful tool for segmenting your API for different consumers. Common examples of audiences include public and beta.

1
groups:
2
  sdks:
3
    audiences:
4
      - public
5
    generators:
6
      - name: fernapi/fern-tyepscript-node-sdk
7
        version: 0.8.8

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

Audiences for servers

To mark a server with a particular audience, add the x-fern-server-name and x-fern-audiences extension to the relevant server.

In the example below, the Production server is only available to public consumers:

1
servers:
2
  - url: https://api.com
3
    x-fern-server-name: Production
4
    x-fern-audiences:
5
      - public

Audiences for endpoints

To mark an endpoint with a particular audience, add the x-fern-audiences extension to the relevant endpoint.

In the example below, the POST /users/sendEmail endpoint is only available to public consumers:

1
paths:
2
  /users/sendEmail:
3
    post:
4
      x-fern-audiences:
5
        - public
6
      operationId: send_email

Audiences for schemas

Schemas can be marked for different audiences, as well.

In this example, the Email type is available to both public and beta customers.

1
components:
2
  schemas:
3
    Email:
4
      title: Email
5
      type: object
6
      properties:
7
        subject:
8
          type: string
9
        body:
10
          type: string
11
        to:
12
          type: string
13
      x-fern-audiences:
14
        - public
15
        - beta

Audiences for properties

Properties can be marked for different audiences, as well.

In this example, the to property is available to beta customers only.

1
components:
2
  schemas:
3
    Email:
4
      title: Email
5
      type: object
6
      properties:
7
        subject:
8
          type: string
9
        body:
10
          type: string
11
        to:
12
          type: string
13
          x-fern-audiences:
14
            - beta