API Browser

The API Browser is a comprehensive tool that showcases all available endpoints within the API, complete with their respective methods, parameters, and data models.

Endpoints

Endpoints provide descriptions of their functionality, addresses for both RPC and HTTP requests, and include a "Try this endpoint" feature. This feature allows users to directly send requests through the API Browser.

Caution: The API Playground is live, meaning any modifications made will impact the live system.

Models

To view models, click the button located in the top right corner of the Endpoints section. This action reveals all the models related to the current module, detailing both database fields and, in some instances, virtual fields that the system fills automatically. Models also display data types, serving as a valuable reference for utilizing the Flow API.