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.
Book a demoLog inStart for free
  • Getting started
    • Overview
    • How it works
    • Quickstart
    • Project structure
    • Customer showcase
    • Changelog
  • Configuration
    • Overview
    • Site-level settings
    • Page-level settings
  • Writing content
    • Markdown basics
    • Rich media in Markdown
    • Fern Editor
    • Reusable snippets
  • AI features
    • Overview
    • Fern Writer
    • AI-generated examples
    • Markdown access
      • Overview
      • Customize LLM output
      • Agent directives
      • Analytics and integration
    • MCP server
    • API catalog discovery
      • Overview
        • REST API Reference
        • Webhook Reference
        • WebSocket Reference
        • OpenRPC Reference
        • gRPC Reference
        • GraphQL Reference
        • Library Reference
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricing

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
Book a demoLog inStart for free
On this page
  • Configuration
  • Include more than one WebSocket Reference
API ReferencesGeneration

Generate WebSocket Reference

||View as Markdown|
Was this page helpful?
Edit this page
Previous

Generate Webhook Reference

Next

Generate OpenRPC Reference

Fern generates WebSocket Reference documentation from an AsyncAPI specification.

WebSocket API Reference Example
Example of how a WebSocket API Reference renders in Fern

Configuration

1

Set up your project structure

Add your specification file to your /fern directory and create a generators.yml that references it:

generators.yml
1api:
2 path: asyncapi.yml
3 origin: https://github.com/your-org/your-repo/blob/main/asyncapi.yml # optional
2

Add the WebSocket Reference to your navigation

Add - api: API Reference to your navigation in docs.yml:

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

Customize the layout

For a full list of configuration options and layout customizations, see Customize API Reference layout.

Include more than one WebSocket Reference

To include multiple WebSocket definitions in your documentation, use the api-name property. The api-name corresponds to the folder name containing your WebSocket definition.

fern
fern.config.json
docs.yml
streaming-api
asyncapi.yml# Streaming WebSocket AsyncAPI spec
generators.yml
realtime-api
asyncapi.yml# Realtime WebSocket AsyncAPI spec
generators.yml
docs.yml
1navigation:
2 - api: Streaming API
3 api-name: streaming-api
4 - api: Realtime API
5 api-name: realtime-api