Dumpling AI Screenshot Webpage

From 15 credits/call
ae_dumplingai_screenshot_webpage

Capture a screenshot or PDF of a webpage using DumplingAI.

Image
From 15 credits/call

Pricing

From 15 credits/call
Scroll before capturePage wait (milliseconds): 0 / Not specifiedPage wait (milliseconds): 1–5000
Disabled / Not specified15 credits/call22.5 credits/call
Enabled22.5 credits/call30 credits/call

Starting price applies to Scroll before capture: Disabled, Page wait (milliseconds): 0.

Parameters

Optional parameters use the platform defaults when omitted.

ParameterTypeRequiredDescriptionDefault
urlstringYesFully-qualified URL to capture.—
waitintegerNoDelay in milliseconds before capturing, allowing the page to finish loading.0
fullPagebooleanNoCapture the entire scrollable page.false
viewportobjectNoBrowser viewport size in pixels.—
viewport.widthintegerYesNo parameter description.—
viewport.heightintegerYesNo parameter description.—
autoScrollbooleanNoScroll the page to trigger lazy-loaded content before capturing.false
clipRectangleobjectNoClipping rectangle when capturing a partial screenshot.—
clipRectangle.topnumberYesNo parameter description.—
clipRectangle.leftnumberYesNo parameter description.—
clipRectangle.widthnumberYesNo parameter description.—
clipRectangle.heightnumberYesNo parameter description.—
requestSourceenum (API | WEB | MAKE_DOT_COM | ZAPIER | N8N | PLAYGROUND | DEFAULT_AUTOMATION | AGENT_PREVIEW | AGENT_LIVE | AUTOPILOT | STUDIO)NoOptional identifier describing where the API request originated.—
blockCookieBannersbooleanNoAttempt 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-Key
Request 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
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