How to use the API documentation when building an Action

This article will tell you how to use the API documentation when building an Action.

Authorization

The API documentation always includes a section on which authorization method is used for this API.

The authorization is needed to create an Action in Watermelon, without this information, we cannot make a connection to your API.

Reference

Within the reference part of the API documentation, you can find what the API can do. The references are usually divided by topic. Per topic, you can find exactly which parameters are needed to execute the request.

Within a chat, the parameters need to be requested. The AI Agent can then provide information based on the responses from the API.

If the topic is not in the API documentation, it is not possible to create an Action for it.