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
      • Overview
      • Accordions
      • Accordion Groups
      • Aside
      • Button
      • Callouts
      • Cards
      • Card Groups
      • Code Blocks
      • Embed
      • Endpoint Request Snippet
      • Endpoint Response Snippet
      • Endpoint Schema Snippet
      • Frames
      • Icons
      • Parameter Fields
      • Steps
      • Tabs
      • Tooltips
    • Visual Editor
    • Reusable Markdown
    • Custom React Components
    • Changelog
LogoLogo
Slack communityLog inBook a demo
Writing ContentComponents

Parameters

Example

Example
Markdown
username
stringRequired

The user’s display name

limit
numberDefaults to 50

Maximum number of items to return

api_key
stringDeprecated

Use OAuth authentication instead

Was this page helpful?
Previous

Steps

Next
Built with

The ParamField component helps document API parameters and properties with consistent formatting. It displays the parameter name, type, requirements, and description in a structured layout.

Properties

path
string

The name of the parameter (e.g., “username”, “limit”)

type
stringRequired

The data type of the parameter (e.g., “string”, “number”, “boolean”)

required
boolean

Indicates if the parameter is required. Displays a “Required” label when true.

default
string

The default value for the parameter, if any

deprecated
boolean

Marks the parameter as deprecated. Shows a “Deprecated” warning when true.