You can use the API tool for an almost unlimited amount of things. Trigger external actions, enrich your data with Large Language Models, send Slack messages, send data to other software tools or get data from other services.

The API tool is an advanced tool. You will call the API endpoint ones for every row in your data - so 10.000 rows = 10.000 API calls. We strongly recommend testing on smaller datasets.

You are responsible for respecting rate limits and general terms of use of whatever APIs that you are interacting with.

Reach out to us if you need support before using the API tool.

​
Configuration

The API tool technically only has two required input. The API comprised of three required input.

You can reference columns in your data in the input from Step #2 to #5. Check out the first example to see how.

1

Select API Method

Select the relevant API Method.

2

Input URL

Input your URL.

3

Optional: Input Headers

Add any relevant header key-value pairs. For instance, an Authorization header to authenticate your API call.

4

Optional: Input Parameters

Add any relevant parameter key-value pairs.

5

Optional: Input JSON Body

Input your JSON body. Particularly relevant for POST calls.

6

Optional: Body Type

Select how Less your treat you API body.

7

Optional: Wait Conditions

Input your wait conditions. This can be very helpful to respect rate limits.

If you input 0.2 seconds wait between each call, you will maximum call 5 calls per seconds.

If you input maximum 300 calls, you will call all 300 calls within the minute as fast as possible but no more than 300 calls per minute.

8

Optional: Stop Conditions

Input the value the value you want to have instead of the value to replace in Step 2. Always use double-quotes ("") around your replacement values. You can also reference existing columns in your dataset for dynamically replace values (see “Dynamically replace value” example).

​
When To Use

There are too many options with the API tool to list here, but generally you can use it to:

  • Extract data with GET calls
  • Send data with POST calls
  • Update data with PUT calls
  • Delete data with DELETE calls

​
Examples