Webpage Screenshot Image Generation

Webpage to Image Rendering

Render a public webpage as a PNG image

What can this API do?

Webpage PNG rendering

Render a public webpage as a PNG image.

Viewport or full page

Capture a fixed viewport or the full rendered page.

Configurable dimensions

Choose output and viewport dimensions for the target display or report.

Mobile and dark mode

Emulate mobile layout or dark color preferences when needed.

Sharper image output

Adjust device scale to produce higher-density screenshots.

Visual review workflows

Create previews, evidence images, reports, and automated visual checks.

API Document

HTTP Protocol:HTTPS

HTTP Method:GET

HTTP Endpoint:https://api.gugudata.io/v1/websitetools/url2image

Response Type:application/json; charset=utf-8

DEMO Endpoint:https://api.gugudata.io/v1/websitetools/url2image/demo

Live Demo:Try Interactive Demo

Postman Collection:Run in Postman

API Request Parameters

Name	Type	Is Required	Default Value	Remark
appkey	string	true	YOUR_APPKEY	API key used to authenticate the request.
url	string	true		Target webpage URL.
isFullPage	boolean	false	false	Whether the renderer should capture the full page height.
width	integer	false	250	Output width in pixels.
height	integer	false	250	Output height in pixels.
viewportWidth	integer	false	1080	Viewport width in pixels used during page rendering.
viewportHeight	integer	false	1080	Viewport height in pixels used during page rendering.
forceReload	boolean	false	false	Set to true to bypass a cached rendering and capture the page again.
isMobile	boolean	false	false	Whether the renderer should emulate a mobile device viewport.
isDarkMode	boolean	false	false	Whether the renderer should emulate dark mode when rendering the target page.
deviceScaleFactor	integer	false	1	Device scale factor used during page rendering.

API Response Parameters

Name	Type	Remark
image	binary	Rendered image binary stream returned on success. On failure, the endpoint returns a JSON error payload instead of binary content.

API Response Status Codes

Status Code	Explanation of Status Code	Remarks
200	Request processed successfully.	Some endpoints expose a separate application-level status field in the response body, such as `dataStatus.statusCode`.
400	Invalid request parameters or request format.	Check required fields, data types, and request body format.
401	Missing or unknown application key.	Provide a valid `appkey` with the request.
403	The application key is recognized but access is not allowed.	The key may be expired, inactive, or not permitted for the requested API.
429	Request rate or trial usage limit exceeded.	Reduce request frequency and retry with backoff. If a trial allowance is exhausted, check Trial Keys for remaining requests and subscribe to continue.
500	Internal service error.	Retry later or contact support if the error persists.
503	Upstream service unavailable.	Retry later; the requested upstream dependency is temporarily unavailable.

Remote MCP

AI client access

Use this API through GuGuData Remote MCP

Connect your AI client once, authorize in the browser, and the client can use the GuGuData API tools available to your account. You do not need to paste an appkey into the MCP client.

Endpoint https://mcp.gugudata.io/mcp

Open MCP Guide

Generic MCP configuration

{
  "mcpServers": {
    "gugudata": {
      "url": "https://mcp.gugudata.io/mcp",
      "transportType": "streamable-http"
    }
  }
}

Code Snippets

Run in Postman Open LLM Page

Plan and usage

Common questions about request limits, trials, renewal, and cancellation.

What does the 5 requests per second limit mean?

It is a request-rate limit, not a concurrency allowance. Keep your request rate at or below 5 per second. If the service returns a rate-limit response, reduce the frequency and retry with backoff.

Is total paid usage limited?

There is no total request cap during an active paid subscription and no usage-based overage charge.

How does the free trial work?

Each account can receive a limited trial key. Requests are shared across APIs in the same category. Check Trial Keys for the exact allowance and remaining requests.

How do renewal and cancellation work?

The plan renews annually until canceled. Manage or cancel the renewal from Dashboard → Orders & Billing. Access continues through the paid period after cancellation. See the Terms of Service for the current refund policy. If the billing portal is unavailable, contact support.