REST API quick start

The REST API suits server integrations, reports, and internal tools. For an AI client with a person present, MCP is usually simpler.

1. Create a key

Open Settings → API keys, select Create, and give the key a recognizable name. Copy the full key immediately. It is not shown again after you close the dialog.

2. Store the secret

Keep the key in an environment variable instead of source code:

bash

export VIRALMAXING_API_KEY='vmx_...'

Do not commit .env or put the key in a URL.

3. Make a request

bash

curl --request GET \
  --url https://api.viralmaxing.com/api/users/api-keys/ \
  --header "X-API-Key: $VIRALMAXING_API_KEY"

The request returns the key list without secret values. A 200 response confirms that the key was accepted.

API base URL:

text

https://api.viralmaxing.com/api

Open API Reference to choose a method and inspect its parameters.