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
  • Public API
    • GETJWT from Fern API key
    • GETAlgolia search credentials
    • GETCurrent user information
  • Fern Writer API
    • GETGet Fern Writer Install Link
On this page
  • Pick your API type
  • Customize and enhance
API References

Overview of API References

||View as Markdown|

Fern generates interactive API Reference documentation from an OpenAPI specification or other API formats. Endpoints, type schemas, code snippets, and AI-generated examples are all populated automatically. Users can try requests directly from the docs with the API Explorer, and AI agents and crawlers can discover your APIs via the API catalog endpoint.

Pick your API type

REST

OpenAPI specification

gRPC

Protocol Buffer .proto files

WebSocket

AsyncAPI specification

Webhook

OpenAPI specification

OpenRPC

OpenRPC specification

Library

Python or C++ source code

Customize and enhance

Customize layout

Reorder endpoints, filter by audience, and add Markdown content

SDK snippets

Show SDK code samples alongside your endpoint documentation

HTTP snippets

Display cURL, Python, JavaScript, and Go request examples

Was this page helpful?
Edit this page
Previous

Keyboard shortcuts

Next

Generate REST API Reference

Checking status...
SOC2Soc 2 Type II
© 2026 Fern • Birch Solutions, Inc., a Postman company

Documentation

SDKsDocsAsk FernCLI Reference

API Definitions

OpenAPIAsyncAPIOpenRPCgRPC

Resources

BlogSupportPricingSlack

Company

Brand KitPrivacy PolicyTerms of Service
LogoLogo
Book a demoLog inStart for free