Capture a web page as an image

POST

/v1/image/url

Captures a web page specified by URL as an image

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Query Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

image/*

Image file

🟠400Bad Request

🟠401Unauthorized

🔴500Internal Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://api.convert2pdfapi.com/v1/image/url?url' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "url": "https://example.com",
    "fileName": "screenshot",
    "format": "png",
    "quality": 0,
    "fullPage": false,
    "width": "1280px",
    "height": "720px",
    "deviceScaleFactor": 1
}'

Response Example

{
    "status": "error",
    "message": "Error message"
}

Modified at 2025-10-24 10:13:01

Convert PDF to DOCX

Convert images to PDF