Skip to main content

OpenAPI

caution

Please note that as we are continuously updating and improving our product, there may be discrepancies between the documentation and the current version of the product. If you have any questions or need assistance, please do not hesitate to reach out to us via email and we will be happy to assist you.

OpenAPI, also known as the OpenAPI Specification (OAS), is a specification for describing RESTful APIs. It is a machine-readable format that allows developers to describe the functionality of an API and its endpoints, including the request and response formats, parameters, and other information.

We provide two OpenAPI specifications, the community version and the cloud version.

Community

The community version is specifically designed for the community instance and contains only the routes that are available in the community.

Cloud

The cloud version includes all the routes from the community version plus additional routes that are specific to the cloud instance.