HTTP Response Codes for Website Screenshot API

Every Screenshot API response includes a status code and JSON body describing the result. Successful renders return 200 OK immediately, while queued bulk jobs return 201 Created with a jobId. Error codes provide actionable detail so you can retry, update credentials, or inspect storage settings.

The table below highlights the most common codes youll see when capturing single URLs, bulk lists, or scheduled jobs with AddScreenshots.

CodeTypeDescription
200SuccessYour screenshot request was successfully processed.
201CreatedYour request has been accepted and is being processed in the background, useful for bulk screenshot operations.
400Bad RequestThe request was malformed or missing some parameters; please check your submission.
401UnauthorizedAuthentication failed, often due to a missing, invalid, or expired API Key. Ensure your key is correct and active.
402Payment RequiredYour subscription may need renewal as the last payment attempt failed.
403ForbiddenMissing permissions—typically an expired signed token, incorrect storage credentials, or unsupported HTTP methods.
424Failed DependencyThe operation depended on a third-party service that failed, e.g., inaccessible cloud storage.
500Internal ErrorAn unexpected condition was encountered. Retry shortly and contact support with the request_id if the issue persists.

Troubleshooting Tips

  • Check the JSON body: Error responses include a message, optional request_id, and any upstream error text to help you diagnose issues quickly.
  • 401 or 403? Visit the API Keys page to confirm the key is active, regenerate a secret if needed, and verify signature tokens for public GET requests.
  • 424 Failed Dependency: Ensure your storage provider accepts writes (S3/R2 permissions, SAS token validity, SFTP credentials, etc.).
  • 201 Created: Poll the Job Status endpoint or monitor webhook callbacks to track progress.

Sample Response Payloads

{
  "success": true,
  "message": "Screenshots completed.",
  "storage_provider": "s3",
  "images": [
    {
      "request_url": "https://example.com",
      "image_url": "https://my-bucket.s3.amazonaws.com/example.png"
    }
  ]
}
{
  "success": false,
  "request_id": "req_123",
  "status": 424,
  "message": "Failed to upload screenshot to S3. Check bucket permissions."
}

Need help resolving a status code? View plans or contact support with your request_id and well assist.