The API Tool step allows you to run a custom API call to any another product / service. These are best used to integrate with products / services that Relevance AI doesn’t have dedicated integrations for, but can be used for any product / service.

​
What is an API?

Think of an API like a waiter in a restaurant. You (the user) look at the menu (a list of what’s possible), place your order with the waiter (the API), and then the kitchen (the system or server) prepares the food and the waiter brings it back to you. In the tech world, an API is a set of rules that allows one piece of software (like an app) to talk to another (like a server).
In order to use this Tool step, we would recommend having a beginner level of understanding of what an API is, and how to use them. You can also use the Invent feature to help you use this Tool step to integrate with different products and services.

​
Add the API Tool step to your Tool

You can add the API Tool step to your Tool by:
  1. Creating a new Tool, then searching for the ‘Convert PDF to text’ Tool step
  2. Click ‘Expand’ to see the full Tool step
  3. Select the method you wish to use for your API call
  4. Enter the URL / pathway / endpoint you want to call
  5. Add headers, body and URL parameters as needed for your API call
  6. Click ‘Run step’ to run the Tool step

​
Advanced Settings

​
Response format

Allows you to select the format of the response. You can choose from:
  • string
  • json
  • arrayBuffer
  • blob

​
Cookies

Allows you to add cookies to send with the request.

​
Throw error on 4xx/5xx response

When checked, throws an error when the API response contains a 4xx/5xx response code.

​
Common errors