Dumpling AI Screenshot Webpage
From 15 credits/call
ae_dumplingai_screenshot_webpage
Capture a screenshot or PDF of a webpage using DumplingAI.
From 15 credits/call
Pricing
From 15 credits/call
| Scroll before capture | Page wait (milliseconds): 0 / Not specified | Page wait (milliseconds): 1–5000 |
|---|---|---|
| Disabled / Not specified | 15 credits/call | 22.5 credits/call |
| Enabled | 22.5 credits/call | 30 credits/call |
Starting price applies to Scroll before capture: Disabled, Page wait (milliseconds): 0.
Parameters
Optional parameters use the platform defaults when omitted.
| Parameter | Type | Required | Description | Default |
|---|---|---|---|---|
url | string | Yes | Fully-qualified URL to capture. | — |
wait | integer | No | Delay in milliseconds before capturing, allowing the page to finish loading. | 0 |
fullPage | boolean | No | Capture the entire scrollable page. | false |
viewport | object | No | Browser viewport size in pixels. | — |
viewport.width | integer | Yes | No parameter description. | — |
viewport.height | integer | Yes | No parameter description. | — |
autoScroll | boolean | No | Scroll the page to trigger lazy-loaded content before capturing. | false |
clipRectangle | object | No | Clipping rectangle when capturing a partial screenshot. | — |
clipRectangle.top | number | Yes | No parameter description. | — |
clipRectangle.left | number | Yes | No parameter description. | — |
clipRectangle.width | number | Yes | No parameter description. | — |
clipRectangle.height | number | Yes | No parameter description. | — |
requestSource | enum (API | WEB | MAKE_DOT_COM | ZAPIER | N8N | PLAYGROUND | DEFAULT_AUTOMATION | AGENT_PREVIEW | AGENT_LIVE | AUTOPILOT | STUDIO) | No | Optional identifier describing where the API request originated. | — |
blockCookieBanners | boolean | No | Attempt to hide cookie banners before capturing the screenshot. | true |
Invocation example
Copy the request and explore its response example.
POST
/agent-api/v1/tool/executeX-Api-KeyRequest coderequest.sh
curl --request POST \
--url 'https://agentearth.ai/agent-api/v1/tool/execute?tool_name=ae_dumplingai_screenshot_webpage' \
--header "X-Api-Key: $AGENTEARTH_API_KEY" \
--header 'Content-Type: application/json' \
--data-raw '{
"params": {
"autoScroll": false,
"fullPage": false,
"url": "https://www.youtube.com/@imaalaouiismaili/videos",
"viewport": {
"height": 2100,
"width": 1920
},
"wait": 5000
}
}'Response exampleresponse.json
{
"screenshotUrl": "https://pub-1ff5a17124b34b658b5b75065b3a03e8.r2.dev/temp-833be314-ad00-43cd-872d-c5ba86df5a64.png"
}Guides using this tool
See how this tool fits into real workflows

