Zum Inhalt
HALOWERK

Screenshots

screenshot

Render one URL in headless Chrome and return the screenshot as PNG, WebP or JPEG.

POST https://shot.halowerk.com/screenshot

Eingaben

Felder des veröffentlichten Eingabeschemas
FeldTypPflichtBeschreibung
urlstringJaAbsolute http or https URL to render.
widthintegerNeinViewport width in CSS pixels.
heightintegerNeinViewport height in CSS pixels.
full_pagebooleanNeinCapture the whole document instead of the viewport. Costs 0.006 USDC instead of 0.004 USDC.
formatstringNeinImage format of the returned screenshot.
qualityintegerNeinCompression quality for webp and jpeg. Ignored for png.
delay_msintegerNeinWait this long after the document is ready before capturing. Counts against the 20 second budget.
selectorstringNeinCSS selector. When set, only that element is captured and full_page must stay off.
dark_modebooleanNeinRender with prefers-color-scheme: dark.
block_cookiebannerbooleanNeinRemove common consent layers before capturing. The banner is hidden, never accepted.
Vollständiges Eingabeschema anzeigen
{
  "type": "object",
  "required": [
    "url"
  ],
  "additionalProperties": false,
  "properties": {
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Absolute http or https URL to render."
    },
    "width": {
      "type": "integer",
      "minimum": 320,
      "maximum": 2560,
      "default": 1280,
      "description": "Viewport width in CSS pixels."
    },
    "height": {
      "type": "integer",
      "minimum": 320,
      "maximum": 2000,
      "default": 800,
      "description": "Viewport height in CSS pixels."
    },
    "full_page": {
      "type": "boolean",
      "default": false,
      "description": "Capture the whole document instead of the viewport. Costs 0.006 USDC instead of 0.004 USDC."
    },
    "format": {
      "type": "string",
      "enum": [
        "png",
        "webp",
        "jpeg"
      ],
      "default": "png",
      "description": "Image format of the returned screenshot."
    },
    "quality": {
      "type": "integer",
      "minimum": 1,
      "maximum": 100,
      "default": 80,
      "description": "Compression quality for webp and jpeg. Ignored for png."
    },
    "delay_ms": {
      "type": "integer",
      "minimum": 0,
      "maximum": 10000,
      "default": 0,
      "description": "Wait this long after the document is ready before capturing. Counts against the 20 second budget."
    },
    "selector": {
      "type": "string",
      "maxLength": 300,
      "description": "CSS selector. When set, only that element is captured and full_page must stay off."
    },
    "dark_mode": {
      "type": "boolean",
      "default": false,
      "description": "Render with prefers-color-scheme: dark."
    },
    "block_cookiebanner": {
      "type": "boolean",
      "default": false,
      "description": "Remove common consent layers before capturing. The banner is hidden, never accepted."
    }
  }
}

Originalschema öffnen

Veröffentlichtes Eingabebeispiel

{
  "url": "https://example.com/",
  "width": 1280,
  "height": 800,
  "full_page": false,
  "format": "png",
  "quality": 80,
  "delay_ms": 0,
  "dark_mode": false,
  "block_cookiebanner": false
}

Ergebnis & Dokumentation

Maschinenlesbare Dokumentation dieses Hubs

Quelle dieser Seite: der veröffentlichte HALOWERK-Katalog. Stand: 2026-11-01, 15:19 UTC.

Weitere Endpunkte dieses Hubs

Alle Endpunkte dieses Hubs →