# API Query Parameters

### Parameter Name:

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

* *Input Field Type:* Text Field
* *Description:* This field allows the user to name one of the parameters 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.

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

### Value:&#x20;

* *Input Field Type:* Text Field
* *Description:* This field allows the user to declare the value of the parameter, if it requires a user's input leave it blank, if the value doesn't change input the unchanged value.
  * *Usage:* The input in this value field will query the correct information from the dataset of the API and return desired information.

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

### Description:

* *Input Field Type:* Text Field
* *Description:* This field allows the user to specify the exact format of needed input for parameter (Ex. Ticker for Company or YYYY-MM-DD).
* *Usage:* Enter a concise and descriptive description so that the agent assigned to the Custom API is able to ask the user for the correct further information if needed.

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

### Required:

* *Input Field Type:* Check Box
* *Description:* This field allows the user to declare the parameter for the API required or not. Usually, will always be required unless it is the token which where a value will already have an input.&#x20;
* *Usage:* Double check with the API implementation of the Custom API so that the agent utilizing the Custom doesn't crash when trying to query for information it cannot find.&#x20;

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


---

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