Overview
ForgeAI API keys let you authenticate requests to account-scoped endpoints without maintaining a live browser session. You can create keys from your account dashboard and use them in server-to-server integrations, bots, or custom tooling.API keys are currently issued for personal use. They are tied to your Privy account (your Solana wallet identity). Each user can have up to 10 active keys.
Creating an API Key
- Sign in to forgeai.gg.
- Navigate to Account → API Keys.
- Click Create New Key.
- Give the key a name (e.g.
my-bot-prod). - Optionally set an expiry (1–365 days) and a webhook URL.
- Click Create.
Key format
API keys have a prefix followed by a random secret:keyPrefix) is stored in plaintext and shown in the key list view. Use it to identify which key is which without exposing the secret.
Using an API Key
Pass the key in theAuthorization header:
Scopes
When creating a key you can specify scopes. Current supported scopes:| Scope | Description |
|---|---|
read | Read-only access |
write | Write access |
["read", "write"].
Webhook Configuration
If you provide awebhookUrl at creation time, ForgeAI will generate a webhookSecret (returned once at creation). Use this secret to verify the signature of incoming webhook requests from ForgeAI.
Webhook payloads are signed using HMAC-SHA256 with the shared secret. Validate the signature on your server before processing the payload.
Revoking a Key
From the dashboard:- Go to Account → API Keys.
- Find the key you want to revoke.
- Click Revoke.
Key Management Best Practices
Use one key per integration
Use one key per integration
Create separate keys for each application or script. This lets you revoke access for a specific integration without affecting others.
Set expiry dates
Set expiry dates
For keys used in automated pipelines, set an expiry date and rotate them regularly. This limits the blast radius if a key is accidentally exposed.
Never commit keys to version control
Never commit keys to version control
Store API keys in environment variables or a secrets manager, never in your codebase or repository.
Monitor last used timestamps
Monitor last used timestamps
The API key list shows the
lastUsedAt timestamp for each key. Keys that have not been used recently are candidates for revocation.Next Steps
API Reference
Full endpoint reference including authentication details.
Register for a Tournament
Use the API to automate tournament registration.