> For the complete documentation index, see [llms.txt](https://doc1.antgst.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://doc1.antgst.com/help-center/technology-access/api/api-key.md).

# API key

#### 1. Where to Find It

To access your API credentials:

<figure><img src="https://1063803597-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeMT6j6yprSW9Vl5MB4Oi%2Fuploads%2Fgit-blob-f8e65b756af5ab82f8230beb0b1a6a02dfa1f123%2Fimage%20(2).png?alt=media" alt=""><figcaption></figcaption></figure>

1. Log in to the console and go to the **Dashboard** (Home page).
2. Under **Technology Access**, click on **"HTTP API"**.
3. You will be redirected to the **API Key Management** page.

> 📌 Tip: This section is only visible if your account has enabled HTTP API access.

***

#### 2. Function Description

The **API Key** page allows you to manage authentication credentials for integrating your systems with our SMS services via HTTP API.

<figure><img src="https://1063803597-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FeMT6j6yprSW9Vl5MB4Oi%2Fuploads%2Fgit-blob-4c38922d71f5905b9c1adb24031e486ecaf6b100%2Fimage%20(3).png?alt=media" alt=""><figcaption></figcaption></figure>

**Key Features:**

* **API Key**: A unique identifier used to authenticate your requests.
* **API Secret**: The secret key used to sign your API calls (never share this!).
* **IP Whitelist**: Restrict API access to specific IP addresses for enhanced security.
  * Default: `0.0.0.0` (means all IPs allowed)
  * Recommended: Add your server’s IP to improve security
* **Operation**:
  * 🔍 Click **eye icon** to view the API secret (hidden by default)
  * 💾 Click **copy icon** to copy the key or secret
  * 🗑️ Click **Delete** to revoke access (creates a new key automatically)

**Buttons:**

* **Add API Key**: Generate a new API key pair (recommended for rotation)
* **Add to whitelist**: Set or edit the allowed IP address list

> ⚠️ **Security Notice**: Never expose your API secret in client-side code, logs, or public repositories. Always use environment variables or secure vaults.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## 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, and the optional `goal` query parameter:

```
GET https://doc1.antgst.com/help-center/technology-access/api/api-key.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.