Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. Locate the JSON API element under the Tool PluginTools section of the palette.
  2. Drag and drop the File element into the “Drop the Drop a tool here” section.to here section.
    Image Added

Configure form properties

Image Added

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 TypeSelect the type of call:
    • GET
    • POST 
    • PUT
    • DELETE 
  • Request HeadersAdd 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.

Here’s your formatted set of tables:

First Table: Primary Items

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.