Skip to main content

External API Tool

External API Tool allows an agent to make remote API calls on tool invocation. This tool is particularly useful to connect agents to custom or proprietary APIs.

Using the API Tool, your Agent will call the desired API when the right conditions are met. You can customize the API type, header, parameters and much more.

Download

How to Configure the API Tool​

As with every tool, it is mandatory to assign a name and a description to the tool.

It is also required to configure:

  • Method: HTTP method to use for the remote call
  • URL: The URL to call
  • Timeout: The timeout in milliseconds of the HTTP request
  • Authentication: The authentication method for the API call (None, Header, Query String)

In case of authentication type Header or Query String it is required to also configure one or more key-value params which will be used as authentication keys.

Authentication Parameters

HTTP Parameters​

An agent can set API call parameters dynamically according to the parameters settings. A parameter requires:

  • key: the parameter name as it will be sent to the API. Must be a string without spaces
  • type: a type (i.e., String, Number, etc.) in order to inform the agent of the expected type to produce
  • description: a description that explains to the agent what the specific parameter means and how to populate it
  • required: a flag that tells the agent if the parameter is required or not
HTTP Parameters