API Key Management
API keys allow external applications and AI agents to interact with your SiteX installation. Manage keys from API Keys in the admin panel.
Creating an API Key
- Click Generate New Key
- Enter a descriptive name (e.g., "PaperclipAI Production")
- Select permissions for this key
- Optionally configure IP whitelisting
- Set an expiration date (optional)
- Click Create
Important: The full API key is shown only once upon creation. Copy it immediately and store it securely. You cannot retrieve it later.
Key Format
API keys follow the format: sx_live_xxxxxxxxxxxxxxxxxxxx (live) or sx_test_xxxxxxxxxxxxxxxxxxxx (test mode). Test keys work identically but content created with them is marked as "test" and not publicly visible.
Managing Keys
From the API Keys list, you can:
- View usage stats - Requests today, this month, total
- Edit permissions - Change what the key can access
- Regenerate - Create a new key value (old key stops working immediately)
- Disable - Temporarily deactivate without deleting
- Delete - Permanently remove the key
Rate Limits
Each API key has configurable rate limits. Default: 60 requests per minute, 1000 per hour. See Rate Limits for details.
Security Recommendations
- Use separate keys for each application or agent
- Apply the minimum required permissions
- Enable IP whitelisting when possible
- Rotate keys periodically
- Monitor usage for unusual activity