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
      • 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
      • Schema snippet
      • 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
  • 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
  • Usage
  • Combining with the Schema component
  • Properties
Writing contentComponents

Schema snippet

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

Schema

Next

Step

The <SchemaSnippet> component displays type definitions from your API Reference as a JSON code block. Use it on its own to display the JSON representation, or pair it with the <Schema> component to show both the field-by-field breakdown and JSON together. When AI agents fetch the Markdown version of a page, the JSON code block is included as a fenced code block in the Markdown output.

The component only discovers types referenced by endpoints. Types exclusively used by websockets or webhooks won’t be available. If multiple APIs have the same type name, the component returns the first match.

Usage

The component works with API references already configured in your docs.yml. This example displays the AIChatConfig type as a JSON code block:

The AIChatConfig Object
1{
2  "model": "claude-3.5",
3  "system-prompt": "string"
4}
Markdown
1<SchemaSnippet type="AIChatConfig" title="The AIChatConfig Object" />

Combining with the Schema component

Use <SchemaSnippet> alongside <Schema> to display both the JSON representation and the detailed field breakdown:

The AIChatConfig Object
1{
2  "model": "claude-3.5",
3  "system-prompt": "string"
4}
modelenumOptional
Allowed values:
system-promptstringOptional
This is a system prompt that acts as context given to the LLM for AI chat.
Markdown
1<SchemaSnippet type="AIChatConfig" title="The AIChatConfig Object" />
2
3<Schema type="AIChatConfig" />

Properties

type
stringRequired

The name of the type to display. The component searches for this type across all endpoints in your API definition.

title
string

Optional title displayed above the JSON code block.

className
string

Optional CSS class name for custom styling.

highlight
number | number[]

Line numbers to highlight in the code snippet. Accepts a single number, an array of numbers, or ranges (e.g., {[1-3, 5]}).