Processed or queued
Use the image result immediately, or track an asynchronous job until it completes.
API reference
Know exactly what happened after every request.
Read Screenshot API status codes at a glance, understand the response body, and take the right recovery action without interrupting your automation.
- Standard HTTP status codes
- Actionable JSON messages
- Request IDs for support
200
Screenshot completedRequest processed successfully
{
"success": true,
"message": "Screenshots completed.",
"storage_provider": "s3",
"images": [ ... ]
}Fast diagnosis
Start with the status family
Every response includes an HTTP status and a JSON body. Use the status to choose the workflow, then read message and request_id for the precise detail.
Request needs attention
Review parameters, credentials, subscription status, permissions, or storage configuration.
Retry safely
Retry after a short delay. Include the request ID when contacting support if it persists.
Status reference
Response codes and next actions
Successful renders return 200 OK immediately. Queued bulk jobs return 201 Created with a jobId.
| Code | Meaning | What happened | Next action |
|---|---|---|---|
| 200 | Success | The screenshot request was successfully processed. | Use the returned image or storage URL. |
| 201 | Created | The request was accepted for background processing, commonly for bulk operations. | Poll job status using jobId or wait for a webhook. |
| 400 | Bad Request | The request was malformed or required parameters were missing. | Check the JSON body, URL and parameter names. |
| 401 | Unauthorized | Authentication failed because the API key is missing, invalid or expired. | Confirm the key is active and sent correctly. |
| 402 | Payment Required | The subscription may need renewal because the last payment attempt failed. | Review the account billing status. |
| 403 | Forbidden | Permissions are missing, commonly from an expired token, storage credentials, or unsupported method. | Refresh the token and verify permissions. |
| 424 | Failed Dependency | A required third-party service failed, such as inaccessible cloud storage. | Test provider credentials and write access. |
| 500 | Internal Error | The API encountered an unexpected condition. | Retry shortly; share request_id with support if it persists. |
Troubleshooting
Resolve the common failure paths
Keep the response body and request ID in your application logs. They are the fastest route from a failed request to a specific fix.
Read the JSON body
Error responses include a message, optional request_id, and available upstream error details.
Verify 401 and 403
Confirm your key on the API Keys page, regenerate secrets when needed, and refresh signed public tokens.
Check a 424 dependency
Ensure your storage provider accepts writes and its credentials, tokens, and permissions remain valid.
Track a 201 job
Use the jobId workflow in the bulk screenshot guide or monitor webhook callbacks for completion.
JSON examples
Compare success and error payloads
Branch on the HTTP status first, then use the structured body to update your job state, log context, or present an actionable error.
200Successful capture
{
"success": true,
"message": "Screenshots completed.",
"storage_provider": "s3",
"images": [
{
"request_url": "https://example.com",
"image_url": "https://my-bucket.s3.amazonaws.com/example.png"
}
]
}424Storage dependency failed
{
"success": false,
"request_id": "req_123",
"status": 424,
"message": "Failed to upload screenshot to S3. Check bucket permissions."
}Still investigating?
Bring the request ID. We’ll help with the rest.
Share the status, response body, and request_id so support can trace the request quickly.