Call API

Use this action to call an API you created in the Data & API tab.

If you're new to APIs, see: Create APIs → and Calling from the interface →.

How the action appears in the editor

• Each API you create appears as an interface action in the add action menu under Workflows → API.

• Actions are labeled with your API's name (for example: "create_invoice" or "add_new_task").

• Once an API is selected, you will be able to configure all the parameters it requires.

Configuration

Parameters

When you have an API selected, you will see all its respective expected parameters in the configuration panel:

Here, you can define a set value for a parameter, or pass a dynamic value by binding the value to something like a variable or input value.

WHERE DO PARAMETER FIELDS COME FROM?

The list of parameters you see is based on the input parameters that have been configured for the API.

Learn more about input parameters →

Headers

If you wish, you can also configure the headers that are passed to the API when you call it.

Example flow

1. Create an API in Data & API → Backend Workflows → API Endpoints (for example: "create_order"), and define its parameters (e.g., items_ordered, note, delivery_address) and response.
2. In your interface workflow, click + Add an action, navigate to Workflows → API, and select your create_order API.
3. Bind the API's parameters to your dynamic data, such as the values of variables or form fields.
4. Use a Try/Catch or If action to handle success vs. error responses. On success, continue your UI flow (e.g., navigate to the order confirmation page).