URL Parameter

The url parameter is required for the Screenshot API and specifies which webpage to capture.

Specifications

Property	Value
Type	string
Required	Yes
Default	None
API	Screenshot API only

Description

The URL of the webpage you want to screenshot. The URL must be:

• Publicly accessible
• A valid URL with protocol (http:// or https://)
• Responsive within a reasonable timeout period

Examples

Basic URL Screenshot

{
    "url": "https://example.com"
}

Response:

{
    "success": true,
    "credits_remaining": 95,
    "id": "abc123",
    "url": "https://i.html2img.com/abc123.png"
}

URL with Query Parameters

{
    "url": "https://example.com/search?q=test&page=1"
}

URL with Specific Viewport

{
    "url": "https://example.com",
    "width": 1920,
    "height": 1080
}