Error Codes & Rate Limits

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The url field is required.",
    "status": 422,
    "details": {
      "url": ["The url field is required."]
    }
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The url field is required.",
    "status": 422,
    "details": {
      "url": ["The url field is required."]
    }
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The url field must be a valid URL.",
    "status": 422,
    "details": {
      "url": ["The url field must be a valid URL."]
    }
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The width field must be between 320 and 3840.",
    "status": 422,
    "details": {
      "width": ["The width field must be between 320 and 3840."]
    }
  }
}

{
  "error": {
    "code": "RATE_LIMIT_EXCEEDED",
    "message": "Rate limit exceeded. Try again in 45 seconds.",
    "status": 429
  }
}

{
  "error": {
    "code": "USAGE_LIMIT_EXCEEDED",
    "message": "Monthly screenshot limit reached. Upgrade your plan for more screenshots.",
    "status": 402
  }
}

{
  "error": {
    "code": "NOT_READY",
    "message": "Screenshot is not ready yet.",
    "status": 404
  }
}

{
  "error": {
    "code": "EXPIRED",
    "message": "Screenshot has expired.",
    "status": 410
  }
}

$response = Http::withToken(env('SCREENSHOT_API_KEY'))
    ->post('https://screenshotrun.com/api/v1/screenshots', [
        'url' => 'https://example.com',
    ]);

if ($response->successful()) {
    $screenshot = $response->json('data');
    // Handle success...
} elseif ($response->status() === 429) {
    $retryAfter = $response->header('X-RateLimit-Reset');
    // Wait and retry...
} elseif ($response->status() === 422) {
    $error = $response->json('error');
    // Handle validation error...
} else {
    $error = $response->json('error');
    Log::error("API Error: {$error['code']} - {$error['message']}");
}

import requests
import time

response = requests.post(
    "https://screenshotrun.com/api/v1/screenshots",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"url": "https://example.com"}
)

if response.ok:
    screenshot = response.json()["data"]
    # Handle success...
elif response.status_code == 429:
    reset_at = int(response.headers.get("X-RateLimit-Reset", 0))
    wait_seconds = max(reset_at - int(time.time()), 1)
    time.sleep(wait_seconds)
    # Retry the request...
else:
    error = response.json()["error"]
    print(f"Error [{error['code']}]: {error['message']}")

const response = await fetch("https://screenshotrun.com/api/v1/screenshots", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://example.com" }),
});

if (response.ok) {
  const { data } = await response.json();
  // Handle success...
} else if (response.status === 429) {
  const resetAt = response.headers.get("X-RateLimit-Reset");
  const waitMs = Math.max(resetAt * 1000 - Date.now(), 1000);
  await new Promise((resolve) => setTimeout(resolve, waitMs));
  // Retry the request...
} else {
  const { error } = await response.json();
  console.error(`Error [${error.code}]: ${error.message}`);
}