Render a shareable preview image for any URL.

Builds a hero-style card that highlights the page domain, title, description, and a trimmed excerpt. Use it for link previews, changelog banners, or social posts. Drop this helper wherever you want to render a shareable preview image for any URL with a single HTTP call. Send the documented inputs and the API streams back polished results you can hand directly to your users.

GETPOST/web/page-image

Where this helper shines

Render a shareable preview image for any URL. keeps web helpers on autopilot. Use it whenever you need to render a shareable preview image for any URL without pausing a sprint or asking design/dev to jump in.

Trigger this helper whenever you need to render a shareable preview image for any URL without waiting on a full deploy.
Drop it into automations (Zapier, Make, workers) to render a shareable preview image for any URL as part of your workflow.
Share the GET URL so support and success can render a shareable preview image for any URL safely using their Dataczar API key.

Copy & ship snippets

GET

Instant link

GET https://api.dataczar.app/web/page-image?url=https%3A%2F%2Fexample.com%2Fsample.png&width=640&height=480&format=png&ak=demo

Open directly in any browser, webhook, or low-code workflow.

curl

curl GET

curl "https://api.dataczar.app/web/page-image?url=https%3A%2F%2Fexample.com%2Fsample.png&width=640&height=480&format=png&ak=demo"

Swap ak=demo with your Dataczar API key.

curl

curl POST

curl -X POST "https://api.dataczar.app/web/page-image?ak=demo" \
  -H 'Content-Type: application/json' \
  -d '{
  "url": "https://example.com/sample.png",
  "html": "<p>Example</p>",
  "width": 640,
  "height": 480,
  "format": "png",
  "timeout": 60,
  "dryrun": true
}'

Send JSON payloads from back-end jobs, queues, or workers.

Parameters

Query Parameters

Name	Type	Description
url	string	Page to summarize.
width	integer	Image width (default 1200).
height	integer	Image height (default 630).
format	string	png, jpg, webp, etc. Defaults to png.
timeout	number	Fetch timeout in seconds.
dryrun	boolean	Return a JSON summary instead of an image.

All helper calls accept your Dataczar key via the ak query parameter. Need one? Create or copy a key on Dataczar Connect and drop it into each request.

Responses

Status 200

PNG/JPEG preview image.

Examples

Test Contracts

[
  {
    "name": "inline_preview",
    "method": "POST",
    "body": {
      "url": "https://example.com/preview",
      "html": "<html><title>Preview</title><p>Example</p></html>",
      "width": 800,
      "height": 420
    },
    "expect": {
      "status_code": 200
    }
  }
]

API key

HTTP method

Query parameters

url optionalwidth optionalheight optionalformat optionaltimeout optionaldryrun optional

Body parameters

We'll send these as JSON for POST/PUT/PATCH requests and as query params for GET.

url optionalhtml optionalwidth optionalheight optionalformat optionaltimeout optionaldryrun optional

Equivalent curl

Grab your Dataczar API key

Every helper runs with the same simple API key. Sign in (or create a free Dataczar account) at Dataczar Connect to issue keys in seconds, then drop the key into any `ak=` parameter and start shipping.

Get your API key Browse helpers

Tip: reuse the same key across these helpers, or rotate keys per project from the Connect dashboard.