Configure API Reference Output

This page explains how to configure API Reference output for your project’s technical documentation. Configuring the output helps you define how API capabilities, schemas, and examples are presented before you generate documentation.

Overview

API Reference documentation gives technical readers a structured view of the APIs identified in your project. Use it when you need to communicate available API capabilities alongside the schemas and code examples that help developers understand how to use them.

You configure this output from the Technical Docs area of your project. The configuration workflow includes selecting API Reference, reviewing Output Settings, and adding examples where they will improve the generated reference.

The interface indicates configuration progress with 2. Configured. After configuration is complete, you can generate the documentation and review the resulting API Reference output.

📷 Screenshot pending: Technical Docs workspace showing the API Reference option and configuration progress

Prerequisites

Before you begin, make sure you have:

Access to the project for which you want to create technical documentation.
Opened the project’s Technical Docs area.
API capabilities and schema information available in the project for documentation.
Any code examples you want to include prepared for review.
A decision about whether you want to create new documentation or use Or import existing documentation.

Step-by-Step Instructions

Open your project’s Technical Docs area.
Select Technical if you are choosing the type of documentation to create.
Select API Reference to configure API-focused documentation output.
Click Configure → to open the documentation configuration workflow.
Select Output Settings to review the output options for the API Reference.
Review the API capabilities included in the reference output.
Review the available API schema information included in the reference output.
Select Add examples when you want to include examples with the API Reference.
Select Add code examples when you want examples that demonstrate API usage in code.
Choose the documentation style in the style selector that best fits the intended audience and level of detail.
Confirm that the configuration status shows 2. Configured.
Click Generate Documentation → to create the configured API Reference output.
Select View Your Documentation → to review the generated documentation.

📷 Screenshot pending: API Reference configuration showing Output Settings, example options, and the Generate Documentation button

Tips and Best Practices

Configure API Reference output only after the relevant API capabilities and schemas are available in the project. The usefulness of the generated reference depends on the available project information.
Use Add examples for examples that clarify common API interactions. Examples are most helpful when they show a realistic request, response, or usage scenario rather than repeating schema details.
Use Add code examples when your readers need implementation-oriented guidance. Keep examples focused on the API capability being documented so readers can quickly connect the example to the corresponding reference information.
Review your selected documentation style before generating. A compact style can be useful for readers who need a concise reference, while a more detailed presentation may be better for onboarding or cross-team handoffs.
Check for 2. Configured before selecting Generate Documentation →. This helps ensure that the configuration stage is complete before output is generated.
Use View Your Documentation → after generation to verify that the API capabilities, schemas, and examples appear in a logical order and provide the amount of detail your audience needs.

Troubleshooting

API Reference is not available to select

Return to the Technical Docs area and confirm that you are configuring Technical documentation. Then select API Reference from the available documentation options.

The documentation is not ready to generate

Confirm that the workflow displays 2. Configured. If the status is not shown, click Configure → and review Output Settings, including the API reference content and any examples you want to add.

Generated output does not include the examples you expected

Before generating, use Add examples or Add code examples to include the needed examples. Then select Generate Documentation → again and use View Your Documentation → to review the updated output.