:: documentation

opensms :: docs

$ api keys

API keys authenticate external applications against the OpenSMS API. They belong to your user account and can be revoked at any time.

## creating a key

Create keys from dashboard → api keys. Give each key a descriptive name so you can tell them apart later. You can have multiple keys, for example one per environment.

## key format

Keys are prefixed with opensms_:

opensms_xxxxxxxxxxxxxxxxxxxxxxxxx

## how keys are stored

The full key is shown once, immediately after creation. Only a secure hash of the key is stored, together with a short display prefix. If you lose a key, revoke it and create a new one — it cannot be recovered.

## using a key

Send it as a bearer token in the Authorization header.

header
Authorization: Bearer opensms_xxxxxxxxx

## revoking a key

Revoke a key from the dashboard. A revoked key immediately stops authenticating requests. The key row is retained so it can never be reused.

Next, learn how to send an sms .