Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
GET /v1/screenshots/usage — check your current screenshot usage and remaining credits.
GET https://api.screenshotly.dev/v1/screenshots/usage
| Header | Required | Description |
|---|---|---|
X-API-Key | Yes | Your API key |
{
"success": true,
"data": {
"subscription": {
"status": "active",
"plan": "STARTER"
},
"plan": {
"id": "starter",
"name": "Starter",
"limits": {
"monthly": {
"screenshots": 5000,
"storage": "5 GB"
}
}
},
"limit": 5000,
"usage": 1234,
"remaining": 3766,
"percentUsed": 25
}
}
curl https://api.screenshotly.dev/v1/screenshots/usage \
-H "X-API-Key: $SCREENSHOTLY_API_KEY"