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
      • 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
  • Variants
  • Full request
  • Request path
  • Request query
  • Request body
  • Full response
  • Response body
  • Properties
Writing contentComponents

Endpoint schema snippet

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

Endpoint response snippet

Next

Webhook payload snippet

The <EndpointSchemaSnippet> component displays endpoint schemas from your API Reference. By default, it renders the complete schema, or you can use the selector prop to display specific parts like request body, response, path parameters, or query parameters. When AI agents fetch the Markdown version of a page, Fern renders the schema — field names, types, and descriptions — as structured content in the Markdown output.

To display any type definition by name (not limited to endpoint schemas), use the <Schema> component.

Markdown-rich field descriptions aren’t yet supported and will display as plain text. See the Request path example below.

Usage

Path parameters

domainstringRequired

Request

messageslist of objectsRequired
The messages to use for the chat completion
modelenum or nullOptional
The model to use for the chat completion
Allowed values:
max_tokensinteger or nullOptional100-3500Defaults to 3000
The maximum number of tokens to generate. Note: setting a token count lower than 2000 may result in incomplete responses. You can add a custom system prompt to control the verbosity of the response.
system_promptstring or nullOptional
The system prompt to use for the chat completion
rewrite_queryboolean or nullOptionalDefaults to false
Whether to rewrite the query using query decomposition

Response

turnslist of objectsRequired
The conversation turns in the chat completion
citationslist of stringsRequired
List of citation strings
Markdown
1<EndpointSchemaSnippet endpoint="POST /chat/{domain}" />

Variants

Full request

Passing request as the selector will only render the request schema.

Path parameters

domainstringRequired

Request

messageslist of objectsRequired
The messages to use for the chat completion
modelenum or nullOptional
The model to use for the chat completion
Allowed values:
max_tokensinteger or nullOptional100-3500Defaults to 3000
The maximum number of tokens to generate. Note: setting a token count lower than 2000 may result in incomplete responses. You can add a custom system prompt to control the verbosity of the response.
system_promptstring or nullOptional
The system prompt to use for the chat completion
rewrite_queryboolean or nullOptionalDefaults to false
Whether to rewrite the query using query decomposition
Markdown
1<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request" />

Request path

Path parameters

domainstringRequired
Markdown
1<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request.path" />

Request query

Markdown
1<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request.query" />

Request body

Request

messageslist of objectsRequired
The messages to use for the chat completion
modelenum or nullOptional
The model to use for the chat completion
Allowed values:
max_tokensinteger or nullOptional100-3500Defaults to 3000
The maximum number of tokens to generate. Note: setting a token count lower than 2000 may result in incomplete responses. You can add a custom system prompt to control the verbosity of the response.
system_promptstring or nullOptional
The system prompt to use for the chat completion
rewrite_queryboolean or nullOptionalDefaults to false
Whether to rewrite the query using query decomposition
Markdown
1<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="request.body" />

Full response

Passing response as the selector will only render the response schema.

Response

turnslist of objectsRequired
The conversation turns in the chat completion
citationslist of stringsRequired
List of citation strings
Markdown
1<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="response" />

Response body

Response

turnslist of objectsRequired
The conversation turns in the chat completion
citationslist of stringsRequired
List of citation strings
Markdown
1<EndpointSchemaSnippet endpoint="POST /chat/{domain}" selector="response.body" />

Properties

endpoint
stringRequired

The endpoint to display, in the format METHOD /path (e.g., POST /chat/{domain}). If your API uses namespaces, prefix with the namespace and :: (e.g., payments::POST /chat/{domain}).

selector
string

Selects a specific part of the endpoint schema to display. Supported values: request, request.path, request.query, request.body, response, response.body.