API Reference · API keys

Create API key

Create an API key. The plaintext key is returned once, on creation — store it as a secret.

POST/v1/keys

Headers

Authorizationstringrequired

Your API key as a bearer token: Bearer rk_your_api_key. You can also use the X-Api-Key header.

Body parameters

namestringoptional

A label to identify the key. Defaults to "default".

scopestringoptional

full (default) or send. A send-only key can't manage domains, keys, or webhooks.

sendingDomainIdstringoptional

Restrict the key to sending from a single verified domain (by id).

rateLimitPerSecintegeroptional

Per-key send rate limit. Defaults to 10.

Request

curl -X POST https://api.raanse.com/v1/keys \
  -H "Authorization: Bearer rk_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
        "name": "production",
        "scope": "send"
      }'

Response

201

{
  "success": true,
  "message": "Resource created",
  "statusCode": 201,
  "data": {
    "id": "01JABCDXYZ0000000000000000",
    "name": "production",
    "prefix": "rk_5f3a9c1",
    "scope": "send",
    "plaintextKey": "rk_5f3a9c1b...shown_once",
    "createdAt": "2026-07-02T12:00:00Z"
  }
}