Authentication

​

Create a key

1. Sign in to Mage and open API → API Keys. You can also choose API (Beta), below Agent in the navigation, then select API Keys.
2. Select Create API key, enter a Key name in the popup, and select Create key. Use a name for the service or environment that will use it, such as Production server.
3. In You’re ready to build, select Copy key and store it securely before closing the popup. An editable quick start and playground appear below the key.

​

Authorization header

Authorization: Bearer mage_sk_...

curl --url https://api.mage.space/v1/account \
  --header "Authorization: Bearer $MAGE_API_KEY"

​

Manage keys

• Active lists keys that can authenticate requests. An account may hold up to 10 active keys. To revoke one, select Revoke beside it and confirm in the popup.
• Revoked lists keys that no longer work, including their revocation dates and usage history. Revoked keys do not count toward the active-key limit.

​

Authentication errors

{
  "error": {
    "code": "unauthorized",
    "message": "The API key is invalid or has been revoked."
  }
}