Download AsyncAPI spec

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:

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