Documentation Index
Fetch the complete documentation index at: https://docs.domshot.dev/llms.txt
Use this file to discover all available pages before exploring further.
Error Codes
The DomShot API uses standard HTTP status codes and returns structured error objects.
All errors return a JSON object with the following structure:
{
"error": "error_code",
"errorDescription": "Human-readable error message"
}
| Field | Type | Description |
|---|
error | string | Machine-readable error code |
errorDescription | string | Human-readable error message |
Error codes
401 Unauthorized
invalid_token
Invalid or expired API key.
{
"error": "invalid_token",
"errorDescription": "The API key is invalid or expired"
}
inactive_subscription
No active subscription found.
{
"error": "inactive_subscription",
"errorDescription": "No active subscription found"
}
402 Payment Required
insufficient_balance
Free tier balance exhausted.
{
"error": "insufficient_balance",
"errorDescription": "Free tier balance exhausted. Please upgrade your plan."
}
429 Rate Limit Exceeded
rate_limit_exceeded
Too many requests within the rate limit window.
{
"error": "rate_limit_exceeded",
"errorDescription": "Rate limit exceeded. Try again at 2024-01-01T12:00:00.000Z",
"retryAfter": 30
}
retryAfter or upgrade your plan for higher limits.
500 Internal Server Error
screenshot_failed
Screenshot generation failed.
{
"error": "screenshot_failed",
"errorDescription": "Failed to load the target URL"
}
- Target URL is unreachable
- Page timeout
- Invalid URL
- Internal server error
Solution: Verify the target URL is accessible, try increasing the timeout parameter, or contact support if the issue persists.
Status code reference
| Code | Error | Description |
|---|
| 200 | - | Success |
| 401 | invalid_token | Invalid or expired API key |
| 401 | inactive_subscription | No active subscription |
| 402 | insufficient_balance | Free tier balance exhausted |
| 422 | - | Validation error (invalid parameters) |
| 429 | rate_limit_exceeded | Rate limit exceeded |
| 500 | screenshot_failed | Screenshot generation failed |
| Header | Description |
|---|
X-RateLimit-Limit | Requests per minute allowed for your plan |
X-RateLimit-Remaining | Requests remaining in current window |
X-RateLimit-Reset | ISO timestamp when window resets |
Troubleshooting
| Issue | Solution |
|---|
| Invalid API key | Regenerate in dashboard |
| No active subscription | Subscribe to a plan |
| Rate limit exceeded | Wait or upgrade plan |
| Timeout error | Increase timeout parameter |
| Screenshot blank | Check target URL loads correctly |
| Credits exhausted | Upgrade to paid plan |
