API Documentation

The platform allows you to document your connected API endpoints. You can do this in the API definition section under the Endpoints tab.

Keep in mind that this tab is for documentation only. Endpoints that are not listed here but are available in the API can still be accessed, even if they are not defined in the platform.

Documentation Audience

If the API is intended exclusively for developers, documenting it on the platform may not be necessary. The primary reason to create API documentation on the platform is to make it available to AI agents. These descriptions are later exposed to the AI through the platform MCP.

Documentation Standards

It is crucial to document every endpoint you want the AI agent to use. The agent will only know how to use available endpoints if you provide a comprehensive description of all parameters, including their purpose, as well as the expected request and response formats.

Detailed parameter descriptions are especially helpful, as they explain how each parameter should be used and what function it serves.

Documenting the structure of requests and responses is also important, as the AI needs this information to create valid requests and correctly parse API responses.

Framework-Specific Documentation

#TODO

Add framework-specific guidance and examples to your API documentation.