Get started

Create an API key

API keys authenticate calls to Roam Moon Cloud services.

Steps

Open the API keys section in the console.
Click Create API key and name it after where it will be used, for example "production backend".
Copy the key immediately and store it in your secret manager.

The key is shown only once

We store a hash of the key, never the key itself. If you lose it, nobody, including us, can retrieve it. Create a new key and revoke the old one.

Using the key

Send the key in the X-API-Key header on every request:

cURL

curl https://core.roammoon.com/v1/ai/license-plates/recognize \
  -H "X-API-Key: rm_live_xxxxxxxxxxxx_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" \
  -F "file=@plate.jpg"

The x characters above stand in for your own key. A key is 64 characters long: the prefix rm_live_, a 12-character public id, an underscore, then a 43-character secret.

Only the X-API-Key header is accepted. Authorization is reserved for signed-in user sessions and is rejected:

cURL

# Rejected, because Authorization is reserved for user sessions
curl ... -H "Authorization: Bearer rm_live_..."   # 401 API_KEY_REQUIRED

Keys per plan

Each plan caps how many keys can be active at once:

Plan	API keys
Hobby	3
Pro	20
Scale	100
Enterprise	Custom

Expired and disabled keys do not occupy a slot, so you can rotate keys without upgrading.

Security notes

Never ship a key in a mobile app or browser code, because anyone can read it there.
Use a separate key per environment, so revoking one does not take the others down.
If you suspect a key leaked, disable it; every request using it is refused immediately.

Next: License plate recognition →