Introduction

The JSON API Tool allows your AI agent to interact with external systems by making HTTP requests to JSON-based APIs. This is useful for retrieving or sending data to third-party services, internal microservices, or other RESTful endpoints as part of the agent’s workflow.

Get started

How to use it

To use the JSON API Element:

Adding the JSON API tools

1. Locate the JSON API element under the Tool Plugin section.
2. Drag and drop the File element into the “Drop a tool here” section.

Configure form properties

To properly integrate and configure the JSON API, set the following fields:

• Function Name: A unique name to reference this tool function from within the AI agent.
• Function Description: A short, human-readable explanation of what the function does.
• Function Arguments: Define the inputs your API call needs. 
• Name: The name of the parameter.
• Data Type :  Expected type
• Description : Description of what this parameter represents.
• Is Required? : Indicates if this parameter must be provided when calling the tool.
• JSON URL: The full URL of the API you want to call. You can use hash variables or arguments here.
• Call Type: Select the type of call:
• GET
• POST 
• PUT
• DELETE 
• Request Headers: Add name(s) and value(s) to the request header
• Name : Name (or Type) of the Request Header.
• Value : Link or Value of the Request Header.
• Passover Current Request Cookies: Enable this to forward cookies from the current request (useful for authenticated calls). 
• Debug Mode: Enable this to log request and response data for troubleshooting purposes.