---
title: "Screenshot of a web page"
method: POST
path: "/v1/web/screenshot"
tags: ["Web"]
---

# Screenshot of a web page

`POST /v1/web/screenshot`

## Request

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

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

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Request body

- object
  - `url` string, uri, required: The public page to capture (http or https; pages behind a login cannot be captured)
  - `width` integer: The browser window's width, px — it decides the layout the page shows (under ~768 most sites show their phone layout)
  - `height` integer: The window's height, px: the first screen of the page (ignored with full_page)
  - `wait_ms` integer: Wait this long after the page has loaded before the capture (content that comes in late, animations)
  - `full_page` boolean: The whole page, as tall as it is (for a scroll in a video); default the first screen

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: 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`
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)
