Authentication
All API requests require authentication using your API key.
Getting Your API Key
- Sign in to your reGOTCHA account
- Navigate to Console → API Keys
- Click Create API Key
- Give your key a descriptive name (e.g., "Production", "Development")
- Copy and securely store your API key
Security: Never expose your API key in client-side code or public repositories. Use environment variables to store your key securely.
Using Your API Key
Include your API key in the request body as clientKey:
{
"clientKey": "YOUR_API_KEY",
"task": {
// task details
}
}Multiple API Keys
You can create multiple API keys for different purposes:
- Development - For local testing
- Staging - For pre-production testing
- Production - For live applications
Each key shares your account's credit balance but tracks usage separately, making it easy to monitor usage per environment.
Revoking Keys
If you suspect a key has been compromised:
- Go to Console → API Keys
- Find the compromised key
- Click the Delete button
- Create a new key and update your applications
Rate Limits
API requests are rate-limited per API key to ensure fair usage:
- 30 requests per minute per API key
If you exceed this limit, you'll receive an ERROR_RATE_LIMIT error response with a retry_after value indicating when you can retry.
{
"errorId": 1,
"errorCode": "ERROR_RATE_LIMIT",
"errorDescription": "Rate limit exceeded. Retry after 15 seconds"
}Resource Limits
To ensure fair usage, the following resource limits apply:
| Resource | Limit |
|---|---|
| Projects per user | 2 (as owner) |
| API keys per project | 3 (active keys) |
| API requests | 30 per minute per key |
Need higher limits? Contact us to discuss enterprise plans.