View Categories

Screenshot Ink Api

5 Docs

Welcome

Last Updated: February 24, 2025

Welcome to the ScreenshotInk API! This API lets you capture screenshots of any public webpage by simply providing a URL along with a few optional parameters to control the output. All requests must be authenticated with your personal API key (available on your dashboard). Base Endpoint: https://screenshotink.com/wp-json/screenshotink/v1/capture Overview The ScreenshotInk API captures a screenshot of...

Request Parameters

Last Updated: February 27, 2025

Below are the available query parameters: Parameter Description Type / Range Default url (Required) The full URL of the webpage to capture. String (valid URL) — key (Required) Your personal API key. String — width Sets the browser viewport width (in pixels) for the capture. Integer (100–8000) 1024 height Sets the browser viewport height (in...

Response Format

Last Updated: February 24, 2025

Success Response On a successful capture, you will receive a JSON response in the following format: { "success": true, "cached": false, "file_url": "https://screenshotink.com/wp-content/uploads/screenshotink/abcdef123456.png" } success: Always true on a successful capture. cached: Indicates whether the screenshot was retrieved from a local cache (true) or freshly captured (false). file_url: The URL where your screenshot image is...

Example Requests

Last Updated: February 24, 2025

1. Basic Screenshot Capture Capture a screenshot of https://apple.com using a 1366×768 viewport: GET https://screenshotink.com/wp-json/screenshotink/v1/capture?url=https://apple.com&width=1366&height=768&key=YOUR_API_KEY Example Response { "success": true, "cached": false, "file_url": "https://screenshotink.com/wp-content/uploads/screenshotink/abcdef123456.png" } 2. Full-Page Screenshot with Delay Capture the full scrollable page of https://example.com with a 2-second delay and output as JPEG: GET https://screenshotink.com/wp-json/screenshotink/v1/capture?url=https://example.com&full_size=1&sleep_time=2000&format=jpeg&key=YOUR_API_KEY 3. Scaled Output Capture a screenshot of https://nytimes.com...

Troubleshooting

Last Updated: February 24, 2025

Invalid or Missing API Key:Ensure you include your API key with every request using the key parameter. No Credits Left:If you receive an error stating “No credits left (membership used + extra credits=0),” then you have exhausted your monthly quota and extra credits. Visit your dashboard to upgrade your plan or add more credits. Unexpected...