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
      • Orchestrate GitHub releases
      • Auto-update last updated dates
      • Cursor
      • GitLab
      • Vale
      • Download OpenAPI spec
      • Download AsyncAPI spec
  • 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
  • Available endpoints
  • Usage
Developer tools

Download AsyncAPI spec

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

Download OpenAPI spec

Next

JWT from Fern API key

Fern docs sites automatically serve your raw AsyncAPI 2.6.0 specification for WebSocket channels, so anyone — or any tool — can download it for client generation, contract testing, or importing into tools that support AsyncAPI.

The spec is also linked from your site’s llms.txt, so AI coding assistants like Cursor, Copilot, and Claude can discover and use it to generate accurate WebSocket integrations.

Available endpoints

Every Fern docs site with WebSocket channels exposes the AsyncAPI specification at these paths:

EndpointFormatContent-Type
/asyncapi.jsonJSONapplication/json
/asyncapi.yamlYAMLapplication/x-yaml
/asyncapi.ymlYAMLapplication/x-yaml

The spec includes all WebSocket channels with publish/subscribe messages, path parameters, query parameters, headers as WebSocket bindings, authentication schemes, type definitions as component schemas, and server URLs from your environment configuration. It’s generated from the same API definition that powers your docs, so it’s always up to date.

Usage

Append the endpoint to your docs URL to download the spec:

$# Download as JSON
$curl https://your-docs-site.com/asyncapi.json
$
$# Download as YAML
$curl https://your-docs-site.com/asyncapi.yaml

If your docs site includes multiple API definitions with WebSocket channels, the endpoint returns a listing of available APIs. Use the api query parameter to select a specific one:

$# Get a specific API's spec
>curl https://your-docs-site.com/asyncapi.json?api=my-api-id