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
  • Overview
    • What is an API definition?
    • Project structure
      • Overview
      • Authentication
      • Types
        • Webhooks
        • WebSockets
        • Errors
        • Imports
        • Examples
        • Audiences
        • Availability
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
Fern DefinitionAdvanced

Errors in Fern Definition

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

WebSockets in the Fern Definition

Next

Imports in Fern Definition

Fern Definition isn’t recommended for new customers and Fern isn’t accepting feature requests for this format. It remains supported for existing users.

Errors represent failed (non-200) responses from endpoints.

An error has:

  • An HTTP status code
  • A body type (Optional)
user.yml
1errors:
2 UserNotFoundError:
3 status-code: 404
4 type: UserNotFoundErrorBody
5
6types:
7 UserNotFoundErrorBody:
8 properties:
9 requestedUserId: string