Getting Started
Core Features
How-To Guides
Integrations
Troubleshooting
API References provide a structured, human-readable way to display technical documentation for your software's interfaces. By converting complex schemas into clear, interactive documentation, this feature helps your users understand available data structures, required fields, and example values without needing to read raw configuration files.
API documentation acts as the "manual" for your service. It breaks down technical definitions into intuitive sections, such as:
The system automatically processes your configuration and presents it through a standardized user interface.
| Properties |
| Specific fields or settings within an object. |
| Required | A status indicating that a specific property must be included. |
| Type | The kind of data allowed, such as a string, number, or object. |
| Constraints | Limits placed on data, such as Range or Length. |
Tip
Enable Example Values: If your configuration supports it, turn on the "Show Examples" setting. Seeing a real-world example often helps users understand a complex field faster than a description alone.
Note
Read-Only vs. Write-Only: If your API includes fields that are only for display (read-only) or only for input (write-only), you can toggle these settings to ensure the documentation is not cluttered with irrelevant information.
Warning
Stay Up to Date: Ensure your reference files are correctly linked. If your source configuration changes but the API Reference documentation is not refreshed, users may attempt to use deprecated properties or encounter errors with outdated information.
Depending on your project's needs, the API Reference view can be customized to: