Create API Key

Create an API key for authenticating requests to the Vaayu API.

Create API Key

Create an API key for a merchant or application that will integrate with Vaayu.

API keys authenticate requests to protected Vaayu endpoints.

Endpoint

POST /create-api-key

Request Body

{
  "merchant_name": "Acme Inc."
}

Field	Type	Required	Description
merchant_name	string	Yes	Name of the merchant or application.

Example Request

cURL

curl -X POST "http://127.0.0.1:8000/create-api-key" \
  -H "Content-Type: application/json" \
  -d '{
    "merchant_name": "Acme Inc."
  }'

Example Response

{
  "api_key": "YOUR_GENERATED_API_KEY"
}

Store the API key securely after it is created.

Using the API Key

Send the API key with subsequent authenticated requests using the X-API-Key header.

curl "http://127.0.0.1:8000/balance/0xYourAddress" \
  -H "X-API-Key: YOUR_API_KEY"

Security

Treat API keys like passwords.

• Do not commit API keys to GitHub.
• Do not put API keys in frontend JavaScript.
• Do not share API keys publicly.
• Do not include API keys in screenshots or documentation examples.

For production integrations, store API keys in a secure environment or secrets manager.

Invalid API Key

If an invalid or missing API key is supplied to a protected endpoint:

{
  "detail": "Invalid API Key"
}

The HTTP status is:

401 Unauthorized

Next Steps

Authentication

Learn how to authenticate requests using your API key.

Send Payment

Use your API key to initiate a payment.