API Information

How to Fill Out API Information

The general settings are for configuring and customizing the agent's identity, behavior, and operational parameters. By providing clarity and guidance within this section, users can effectively tailor the agent to meet their specific needs and objectives.

API Name:

• Input Field Type: Text Field

• Description: This field allows the user to specify a unique name for the Custom API.

• Usage: Enter a concise and descriptive name that succinctly identifies the API within the system. This name should facilitate easy recognition and differentiation among multiple APIs.

Call Type:

• Input Field Type: Dropdown Menu (we offer three differed request methods for APIs)

Get

Used to RETRIEVE data from a resource

Post

Used to CREATE a new resource

Put

Used to UPDATE an existing resource

• Description: pick the specific request method used for the Custom API that they are creating as each type has a different function

• Usage: Choose the correct request method in order for you API to be able to retrieve the correct data or else the test API feature at the end will not work. The website whose API you are trying to implement will most likely describe which of the three it is.

Response Type:

• Input Field Type: Dropdown Menu

Json

JSON (JavaScript Object Notation) used for data exchange between systems, APIs, and databases. Represents data as objects (key-value pairs), arrays, and primitive values (strings, numbers, Booleans, null)

Stream

Java streams allow operations such as filtering, mapping, reducing, and sorting data from collections, arrays. NOT RELATED TO JSON, instead streaming data within Java applications.

Specialization: there are specialized streams for primitive types IntStream, LongStream, DoubleStream

• Description: referring to the format or structure in which an API communicates data back to the requester for data. JSON and Stream are the two retrieval data types offered on our platform.

• Usage: Choose the correct request method so that when later testing the Custom API it returns the correct information and in the correct format. JSON is readable and represents data such as objects, arrays, and primitive values while Java Streams are efficient and powerful for data manipulation.

Use OAuth2:

• Input Field Type: Check Box

• Description: authorization framework that enables users to safely share their data better between different applications.

• Usage: Eliminates the need for shared user credentials and provides simple, well-defined authorization flows.

Display when Check Box is NOT checked off

Display when Check Box IS checked off, pops up another drop-down menu that requires selection "Box" to be chosen as an authentication method

• Box: Used to identify a user in the Box API, a common server-side authentication method

API Endpoint:

• Input Field Type: Text Field

• Description: User must enter the API endpoint link without parameters as that will be entered later in either section of "API Header", "API Endpoint Parameters", or "API Endpoint Parameters".

• Usage: Connect the appropriate link to the text field in order to successfully connect to the correct wed database or server, for desired data to be later used by agent using the API function.

Function Prompt:

• Input Field Type: Text Area

• Description: User will write out in the detail what the use of the API will be such as what data it retrieves and what questions will prompt the assigned agent to use this API call.

• Usage: Utilized by the Agent assigned to the Custom API to decide when to utilize the API function to retrieve specific information and datasets to answer a question posed by the user.