# 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.

<figure><img src="/files/HLogQXAyFPdO90jln6sx" alt=""><figcaption></figcaption></figure>

### **API Name:**

<figure><img src="/files/fFrqgzNAN6WgFdOpPUq6" alt=""><figcaption></figcaption></figure>

* *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)

  <figure><img src="/files/lMl4tlYo94nzSbxT0nhj" alt=""><figcaption></figcaption></figure>

{% tabs %}
{% tab title="Get" %}
Used to RETRIEVE data from a resource
{% endtab %}

{% tab title="Post" %}
Used to CREATE a new resource
{% endtab %}

{% tab title="Put" %}
Used to UPDATE an existing resource
{% endtab %}
{% endtabs %}

* *Description:* pick the specific request method used for the Custom API that they are creating as each type has a different function&#x20;
* *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.&#x20;

### **Response Type:**

<figure><img src="/files/xyk8bWEtgXE63zFAzh4e" alt=""><figcaption></figcaption></figure>

* *Input Field Type:* Dropdown Menu

{% tabs %}
{% tab title="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)
{% endtab %}

{% tab title="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*
{% endtab %}
{% endtabs %}

* *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.&#x20;
* *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.&#x20;

### **Use OAuth2:**

<figure><img src="/files/J853yp8sGhXpLRbowqDn" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/FMez4eiumjANLeqoExgG" alt=""><figcaption></figcaption></figure>

* *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.&#x20;
* *Box*: Used to identify a user in the Box API, a common server-side authentication method&#x20;

### **API Endpoint:**

<figure><img src="/files/NzYWG2zd4C18hZuse1lP" alt=""><figcaption></figcaption></figure>

* *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:**

<figure><img src="/files/FP3rnuLb3O42Muod7lJp" alt=""><figcaption></figcaption></figure>

* *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.&#x20;


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.aicrisk.com/admin/custom-apis/adding-a-new-api/api-information.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.