Web

Screenshot of a web page

A public page opened in a fresh browser window of the size you ask for and captured as a picture: its first screen (default), or the whole page as tall as it is (full_page, for a scroll). The window's width decides the layout the site shows — 1440×900 is a desktop visitor's view, 390×844 a phone's, 720×1280 a vertical frame for a reel, 1920×1080 a landscape frame. The picture is copied to our storage and kept 24 hours like every generated file; use its url as an overlay of POST /v1/studio/edit or as the url of the browser-window and page-scroll effects. Public addresses only (no IP addresses or internal names); pages behind a login cannot be captured.

Billing: 1 provider credit per page · Rate limit: 20/min

post/v1/web/screenshot

Request

  • Base URL: https://apihub.co.il
  • URL: https://apihub.co.il/v1/web/screenshot
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Replay-safe: the same execution is returned instead of charging twice

X-Tagstring

Group calls into one job (e.g. one video) — see GET /v1/usage?tag=…

Request body

urlstring uri required

The public page to capture (http or https; pages behind a login cannot be captured)

widthinteger

The browser window's width, px — it decides the layout the page shows (under ~768 most sites show their phone layout)

heightinteger

The window's height, px: the first screen of the page (ignored with full_page)

wait_msinteger

Wait this long after the page has loaded before the capture (content that comes in late, animations)

full_pageboolean

The whole page, as tall as it is (for a scroll in a video); default the first screen

Response

Completed

idstring

Execution id — stable across internal retries; use it with GET /v1/executions/{id}

status'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
operationstring
tagstring nullable

Your X-Tag, if sent

created_atstring date-time
completed_atstring date-time nullable
outputobject

Operation result (see each operation). While a Studio render is processing: stage (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), phase (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), progress (a percent, 0–100) and progress_fraction (0–1), eta_seconds (seconds left, never below 0) and estimate_seconds

errorstring nullable

Changes

No recorded changes to this operation across all 2 revisions of this API.