> For the complete documentation index, see [llms.txt](https://wiki.mobivatebulksms.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://wiki.mobivatebulksms.com/overview/introduction/test-api-key.md).

# Test API Key

You can verify that your API key is valid and correctly configured by making a request to the authentication test endpoint. This endpoint does not send any messages and can be safely used during development or troubleshooting.

### <mark style="color:green;">`POST/GET`</mark> `/auth/test`

#### Example Request

Use the following `curl` command to test your API key:

```bash
curl --location 'https://<hostname>/auth/test' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer YOUR_API_KEY'
```

Replace `YOUR_API_KEY` with the API key you wish to test.

{% hint style="info" %}
All endpoints shown in this documentation use a **sample base URL**. The production API endpoint is provided by our team upon request.
{% endhint %}

#### Response

If the API key is valid, the API will respond with an HTTP `200 OK` status code.

```http
HTTP/1.1 200 OK
```

A successful response confirms that:

* The API key is valid
* Authorization is working correctly
* The key has access to the Mobivate API

If the API key is invalid, expired, or lacks the required permissions, an appropriate `4xx` error response will be returned with a JSON-formatted error message.


---

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

```
GET https://wiki.mobivatebulksms.com/overview/introduction/test-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.