Screenshot

Capture a screenshot of the rendered page as a PNG. The image comes back Base64-encoded, ready to store, embed as a data URI, or decode to a file.

This is a web operation — no AI, metered against your web allowance.

POST/screenshot

Capture a screenshot

Body parameters

Name
url
Type
string
Required
Required
Description
The absolute URL of the page to process. Rendered with headless Chrome, so JavaScript runs and redirects are followed.
Name
report_to
Type
string
Description
Webhook URL — an http or https address URLpipe POSTs the result to when it's ready. Required for async requests (the default); omit it only when you send sync=true. A missing or invalid value returns 422.
Name
sync
Type
boolean
Description
Process the request synchronously, returning the result inline in the response. Defaults to false (async: return a token now, deliver the result to report_to via webhook). See Async & sync modes for the full contract.
Name
max_age
Type
string | integer
Description
How fresh a cached result must be to be accepted. Either an integer number of seconds (3600) or a duration string of the form "<number> <unit>" — units s/min/h/d/w (e.g. "2 hours", "3 days", "30m"). Defaults to 7 days, clamped to a max of 30 days; 0 always bypasses the cache. See Caching for all accepted units.

Response

Content type text/plain — the body is a Base64-encoded PNG. Decode it to bytes, or prefix it with data:image/png;base64, to use it directly in an <img> tag.

POST/screenshot

curl -X POST https://urlpipe.dev/screenshot \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}'

const res = await fetch("https://urlpipe.dev/screenshot", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://example.com" }),
})

Response

iVBORw0KGgoAAAANSUhEUgAABQAAAALQCAYAAABb2m…
(Base64-encoded PNG, truncated)

Decoding the image

curl -s -X POST https://urlpipe.dev/screenshot \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url": "https://example.com"}' \
| base64 --decode > screenshot.png

const res = await fetch("https://urlpipe.dev/screenshot", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({ url: "https://example.com" }),
})

const base64 = await res.text()
const dataUri = `data:image/png;base64,${base64}`

import base64, requests

res = requests.post(
    "https://urlpipe.dev/screenshot",
    headers={"Authorization": "Bearer YOUR_API_KEY"},
    json={"url": "https://example.com"},
)

with open("screenshot.png", "wb") as f:
    f.write(base64.b64decode(res.text))

Screenshots can take a few seconds for heavy pages. For batches or slow sites, consider async mode so you're not holding a connection open.

Responses

Status

When

Body

200 OK

The request succeeded.

Sync: the result, in this endpoint's format (see Response above). Async: a job token — { "token": "…", "status": "accepted" }.

422 Unprocessable Entity

The analysis failed, or a parameter was invalid (a bad max_age, or a missing/invalid report_to in async mode).

{ "error": "<message>" }

429 Too Many Requests

You've hit your monthly quota for this operation's category (checked only on a cache miss).

{ "error": "quota_exceeded", "category", "limit", "used", "resets_at" }

504 Gateway Timeout

Sync only: the analysis didn't finish within 60s. It keeps running — fetch it via GET /result/:token.

{ "error": "processing_timeout", "token": "…" }

401 Unauthorized

Missing or invalid API key.

—

Try it live — no API key needed

Run this endpoint against any URL right in your browser.

Open tool

PreviousHTML

NextMarkdown