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.
Slack communityLog inBook a demo
  • Getting Started
    • Overview
    • Quickstart
    • Customer Showcase
  • Writing Content
    • Markdown
    • Visual Editor
    • Reusable Markdown
    • Custom React Components
      • Generate API Reference
      • SDK Snippets
      • HTTP Snippets
      • Endpoint Errors
      • Audiences
      • Customize API Reference Layout
      • Write Markdown in API Reference
      • Generate Webhook Reference
      • Multiple Server URLs
      • Generate WebSocket Reference
      • Generate OpenRPC Reference
    • Changelog
LogoLogo
Slack communityLog inBook a demo
On this page
  • Configuration
  • Example
API References

Endpoint errors configuration

Was this page helpful?
Previous

Audiences

Use audiences to filter the endpoints, schemas, and properties that are displayed in your API Reference.
Next
Built with

This configuration enables errors to show up on the endpoint pages of your documentation. The error names, codes, and objects returned are configured in your API definition.

Configuration

docs.yml
1navigation:
2  - api: API Reference
3    display-errors: true #<--- add this line

Example

Endpoint errors

By clicking on an error, you can see the error name, code, and object returned. The response also updates to show the error object.

Endpoint errors when expanded