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, add the JSON API tools:

  1. Locate the JSON API element under the Tools section of the palette.
  2. Drag and drop the element into the Drop a tool to here section.

Configure form properties

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

NameDescription
Function NameA unique name to reference this tool function from within the AI agent.
Function DescriptionA short, human-readable explanation of what the function does.
Function Arguments

Define the inputs your API call needs.

NameThe name of the parameter.
Data TypeExpected type (e.g., String, Number, Boolean).
DescriptionDescription of what this parameter represents.
Is Required?Indicates if this parameter must be provided when calling the tool.
JSON URLThe full URL of the API you want to call. You can use hash variables or arguments here.
Call Type

Select the type of call. Options include:

  • GET
  • POST
  • PUT
  • DELETE
Request Headers

Add name(s) and value(s) to the request header.

NameName (or Type) of the Request Header.
ValueLink or Value of the Request Header.
Passover Current Request CookiesEnable this to forward cookies from the current request (useful for authenticated calls).
Debug ModeEnable this to log request and response data for troubleshooting purposes.



  • No labels