Updated October 5, 2026
Errors
Every error has the same body: a code and a message.
{
"error": "credits_exhausted",
"message": "This period's credits are exhausted. Upgrade at https://datasets.gloom.sh/pricing."
}Branch on error. Messages are for people and may change.
401responses carryWWW-Authenticate: Bearer.429and503responses carryRetry-After, in seconds.- Every response carries
X-Request-Id. Quote it when you write to us.
Codes
- Status
400
- Code
invalid_params- Meaning
Request parameters failed validation
- Retry-After
No
- Status
401
- Code
missing_key- Meaning
A product key is required
- Retry-After
No
- Status
401
- Code
invalid_key- Meaning
A product key is required
- Retry-After
No
- Status
401
- Code
wrong_key- Meaning
A product key is required
- Retry-After
No
- Status
402
- Code
plan_required- Meaning
The key's account has no plan, or its plan does not include this dataset or depth
- Retry-After
No
- Status
402
- Code
dataset_not_included- Meaning
The key's account has no plan, or its plan does not include this dataset or depth
- Retry-After
No
- Status
403
- Code
key_disabled- Meaning
This key has been disabled
- Retry-After
No
- Status
404
- Code
not_found- Meaning
The requested stored award or compensation filing was not found
- Retry-After
No
- Status
429
- Code
rate_limited- Meaning
Wait before retrying or upgrade the account
- Retry-After
Yes
- Status
429
- Code
credits_exhausted- Meaning
Wait before retrying or upgrade the account
- Retry-After
Yes
- Status
503
- Code
unavailable- Meaning
Stored data or an internal dependency is temporarily unavailable
- Retry-After
Yes
| Status | Code | Meaning | Retry-After |
|---|---|---|---|
400 |
| Request parameters failed validation | No |
401 |
| A product key is required | No |
401 |
| A product key is required | No |
401 |
| A product key is required | No |
402 |
| The key's account has no plan, or its plan does not include this dataset or depth | No |
402 |
| The key's account has no plan, or its plan does not include this dataset or depth | No |
403 |
| This key has been disabled | No |
404 |
| The requested stored award or compensation filing was not found | No |
429 |
| Wait before retrying or upgrade the account | Yes |
429 |
| Wait before retrying or upgrade the account | Yes |
503 |
| Stored data or an internal dependency is temporarily unavailable | Yes |