API Endpoints & Tools
Welcome to the APIs documentation page. We are constantly improving our documentation to make developers' lives easier.
WaveLight API reference documentation
WaveCloud’s developer platform is a core part of our mission to empower organizations to grow better. Our APIs are designed to enable teams of any shape or size to build robust integrations that help them customize and get the most value out of WaveCloud.
​
All WaveCloud APIs are built using REST conventions and designed to have a predictable URL structure. They use many standard HTTP features, including methods (POST, GET, PUT, DELETE) and error response codes.
​
All WaveCloud API calls are made under https://api.wavelighthealth.com and all responses return standard JSON.
Tools to Help You Create
Our developer tools are designed to help you integrate seamlessly with our APIs, providing a smooth development experience. We support various tools to simplify API testing, code generation, and development workflows. These tools eliminate the need to manually configure API requests, making it easier to focus on building your application.
Postman
Postman is a comprehensive API client that you can use to send authenticated requests to WaveCloud. You can also browse selected collections of our public API endpoints. These collections are regularly monitored by WaveLight to keep the specifications of all request and response fields up to date.
​
Download the Postman client and browse the official WaveCloud Postman collections.
​
Note: The Postman web version is not fully compatible with Google SSE (Server-Sent Events). For proper testing, we recommend downloading and using the desktop version, available at the link above.
Swagger
Swagger is an open specification for defining REST APIs. A Swagger document is the REST API equivalent of a WSDL document for a SOAP-based web service. The Swagger document specifies the list of resources that are available in the REST API and the operations that can be called on those resources.
​
Download the Swagger client and browse the WaveLight API documentation.
Sample Media File
To simplify the understanding of our APIs, we provide an MP4 media file as an example. This file serves as a practical resource for developers to test the upload process and integrate with our video upload API.
​
How to Use
​
-
Download the file and use it in your upload requests.
- Use the appropriate endpoint for media uploads as described in the API documentation.
-
Ensure compliance with the supported format and size specifications.
​
This example helps validate the correct integration before using real files in production.​​
Notice: The media file is compressed in .zip format. Before using it for testing, extract the contents to obtain the MP4 file.