# API Key

<mark style="color:green;">**Path: Application Forms > API Key**</mark>

{% hint style="info" %}
For a quick start, please refer to "[Obtaining API Keys and Calling APIs](/most-common-use-cases/obtaining-api-keys-and-calling-apis.md)".
{% endhint %}

API Key allows you to request an API key for clients.&#x20;

If the API Portal is unavailable, you can submit the request here. The application must go through a review process before it becomes effective.

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

### Search Client <a href="#toc169186150" id="toc169186150"></a>

Enter the keyword to search for the desired clients.

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

### Apply for API Key <a href="#toc169186151" id="toc169186151"></a>

In this section, you can find instructions on how to apply for API Key for this client.

1. Search for the client to add the API key first, and click on the![](/files/7HzUWusFfpih0A65cvX5)icon to access the API ID list page.

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

2. If the client has not applied for an API key, a prompt displaying “**1298 - No information found**” will pop up. Click **OK** to exit and proceed.
3. Click **Apply** to access the API key application page.

* **Effective Date**<mark style="color:red;">**\***</mark>**:** The date from which the API can be used.
* **API Key Name**<mark style="color:red;">**\***</mark>**:** Application name and usage.
* **Expiry Date**<mark style="color:red;">**\***</mark>**:** The date until which the API remains valid.
* **Use Quota (-1 = unlimited)**<mark style="color:red;">**\***</mark>**:** The number of times this API can be used; -1 means unlimited.
* **Description**<mark style="color:red;">**\***</mark>**:** Reason for application.
* **Select API**<mark style="color:red;">**\***</mark>**:** API to apply.

{% hint style="info" %}
To select APIs, it is recommended to select APIs with API sources as registered from the **API Management** > <mark style="color:blue;">**API List**</mark>.
{% endhint %}

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

<figure><img src="/files/5VJKq1RRZrU3nMRwGrXU" alt=""><figcaption></figcaption></figure>

4. Enter keywords in the search field of the selected API, or click on the <img src="/files/BHUvZfQr24vGHbRYklQm" alt="" data-size="line"> icon to access the page of the selected API.

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

5. Several APIs can be selected, and **Save** has to be clicked when finished selecting in order for the system to carry over the selected APIs.

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

6. If the wrong API was selected, select the wrongfully selected API, and click **Delete** to remove it.

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

7. Click **Save** to submit the application.

{% hint style="warning" %}
After submitting the API Key application form, please follow digiRunner’s approval process to complete your request. For detailed information about the approval steps, refer to [Approval Flow](/guide/application-forms/approval-flow-settings.md) & [Applications](/guide/application-forms/applications.md), or view the full application process in this section: [Obtaining API Keys and Calling APIs](/most-common-use-cases/obtaining-api-keys-and-calling-apis.md).
{% endhint %}

### Manage API Key Status <a href="#toc169186152" id="toc169186152"></a>

After the application form is approved by **Applications**, the approved application form can be seen. Reviewed application forms can be viewed, modified and revoked in this section.

1. To view application details, click on the![](/files/dDefjM78ncLr7gobOIrM)icon to access the details page.

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

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

2. To modify an application, click on the![](/files/ImoZIqZ1epYi09xgzDOT)icon to access the change page.
3. Modify the desired fields, and click **Save** to save and exit. Changes will appear in **Applications**, and the form can be updated again before submission for review.

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

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

4. To revoke an application, click on the ![](/files/y6UVzBazzeqY39K2PVom) icon to access the revoke page.
5. Modify the desired fields, and click **Save** to save and exit. Changes will appear in **Applications**, and the form can be updated again before submission for review.

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

<figure><img src="/files/0iYnVQ2hL5X8ifgCII6i" 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.tpi.dev/guide/application-forms/api-key.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.
