LogoLogo
Book a demoLog inStart for free
  • Getting started
    • Overview
    • How it works
    • Quickstart
    • Project structure
    • Customer showcase
    • Changelog
  • Configuration
    • Overview
    • Site settings
    • Page settings
      • Overview
      • Sections, pages, and folders
      • Tabs
      • Versions
      • Products
      • Changelog pages
  • Writing content
    • Markdown basics
    • Rich media in Markdown
      • Overview
      • Accordion
      • Anchor
      • Aside
      • Badge
      • Button
      • Callout
      • Card
      • Code block
      • Copy
      • Download
      • Endpoint request snippet
      • Endpoint response snippet
      • Endpoint schema snippet
      • Webhook payload snippet
      • Files
      • Frame
      • Icon
      • If
      • Indent
      • Parameter field
      • Prompt
      • Runnable endpoint
      • Schema
      • Step
      • Table
      • Tab
      • Tooltip
      • Versions
    • 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
      • fern-docs skill
      • Custom skills
      • Overview
        • Slack app
        • Custom guidance
        • Additional content sources
        • Standalone search widget
        • Overview
          • POSTPost Chat Completion
          • POSTCreate Code Record
          • POSTBatch Create Code Records
          • GETGet Code Record By Id
          • GETGet Code Records
          • DELDelete Code Record By Id
          • DELDelete All Code Records
          • GETGet Conversation By Id
          • POSTCreate Document
          • POSTBatch Create Document
          • GETGet Document By Id
          • PATCHUpdate Document
          • DELDelete Document By Id
          • DELBatch Delete Document
          • GETGet Documents
          • DELDelete All Documents
          • POSTCreate Guidance
          • GETGet Guidance By Id
          • DELDelete Guidance By Id
          • PATCHUpdate
          • GETGet Guidances
          • GETGet Recent Queries
          • GETGet Slack Install Link
          • POSTIndex Website
          • GETGet Website Status
          • GETGet Website By Id
          • GETGet Websites
          • POSTReindex Website
          • DELDelete Website
          • DELDelete All Websites
      • Preview changes
      • Publishing your docs
      • Setting up your domain
      • Reverse proxy setup
      • Multi-source docs
      • Announcement banner
      • Embedded mode
      • Hiding content
      • Search
      • User feedback
      • Custom CSS & JS
      • CSS selectors reference
      • Header and footer
      • Global themes
      • Overview
      • Overview
      • Keyboard shortcuts
      • Overview
        • REST API Reference
        • Webhook Reference
        • WebSocket Reference
        • OpenRPC Reference
        • gRPC Reference
        • GraphQL Reference
        • Library Reference
        • Customize API Reference layout
        • Audiences
        • Write Markdown in API Reference
        • SDK snippets
        • HTTP snippets
        • API Explorer
      • Overview
      • Setting SEO metadata
      • Configuring slugs
      • Redirects
      • Custom robots.txt
      • Overview
        • Password protection
        • SSO
        • JWT
        • OAuth
        • Role-based access control (RBAC)
        • API key injection
      • Overview
      • Overview
      • Set up self-hosted documentation
      • Authentication
      • Previews
      • Health check endpoints
      • Releases
      • Overview
      • PostHog
      • Google
      • Segment
      • Mixpanel
      • Analytics events reference
      • Fullstory
      • Intercom
      • Postman
      • Context7
      • 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
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

GraphQL

GraphQL schema

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

Built with
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