---
title: "Render a URL as an image or video"
method: POST
path: "/v1/render/sync"
---

# Render a URL as an image or video

`POST /v1/render/sync`

## Request body

- union
  - object
    - `format` 'png' | 'jpg' | 'pdf' | 'svg' | 'mp4' | 'webp' | 'webm' | 'html' — The format of the rendered output
    - `url` string, required — The URL to render as an image or video
    - `html` string — The raw HTML to render as an image or video
    - `width` integer — The viewport width of the rendered output
    - `height` integer — The viewport height of the rendered output
    - `block_ads` boolean — Whether to block ads on the rendered page
    - `hide_cookie_banners` boolean — Whether to hide cookie banners on the rendered page
    - `click_accept` boolean — Whether to automatically click accept buttons on the rendered page
    - `gpu` boolean — Whether to enable GPU rendering
    - `retina` boolean — Whether to render the image in retina quality
    - `thumb_width` integer — The width of the thumbnail image
    - `thumb_height` integer — The height of the thumbnail image
    - `full_page` boolean — Whether to capture the full page
    - `selector` string — The CSS selector of an element you would like to capture
    - `delay` string — The amount of milliseconds to delay before taking a screenshot
    - `wait_until` 'requestsfinished' | 'mostrequestsfinished' | 'loaded' | 'domloaded' — When
    - `metadata` boolean — Whether to return metadata about the URL
    - `wait_for` string — CSS selector of an element to wait to be present in the web page before rendering
    - `wait_to_leave` string — CSS selector of an element, such as a loading spinner, to wait to leave the web page before rendering
  - object
    - `format` 'png' | 'jpg' | 'pdf' | 'svg' | 'mp4' | 'webp' | 'webm' | 'html' — The format of the rendered output
    - `url` string — The URL to render as an image or video
    - `html` string, required — The raw HTML to render as an image or video
    - `width` integer — The viewport width of the rendered output
    - `height` integer — The viewport height of the rendered output
    - `block_ads` boolean — Whether to block ads on the rendered page
    - `hide_cookie_banners` boolean — Whether to hide cookie banners on the rendered page
    - `click_accept` boolean — Whether to automatically click accept buttons on the rendered page
    - `gpu` boolean — Whether to enable GPU rendering
    - `retina` boolean — Whether to render the image in retina quality
    - `thumb_width` integer — The width of the thumbnail image
    - `thumb_height` integer — The height of the thumbnail image
    - `full_page` boolean — Whether to capture the full page
    - `selector` string — The CSS selector of an element you would like to capture
    - `delay` string — The amount of milliseconds to delay before taking a screenshot
    - `wait_until` 'requestsfinished' | 'mostrequestsfinished' | 'loaded' | 'domloaded' — When
    - `metadata` boolean — Whether to return metadata about the URL
    - `wait_for` string — CSS selector of an element to wait to be present in the web page before rendering
    - `wait_to_leave` string — CSS selector of an element, such as a loading spinner, to wait to leave the web page before rendering

## Response `200`

Successful operation

- RenderResponse
  - `renderUrl` string, uri — The URL where the rendered output is stored
  - `size` integer — The size of the rendered output in bytes

## Other responses

- `307` — Temporary Redirect
- `400` — Bad request
- `401` — Unauthorized
- `500` — Internal server error

---

[API](https://skmtc.dev/urlbox/apis/urlbox-api.md) · [All operations](https://skmtc.dev/urlbox/apis/urlbox-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/urlbox/urlbox-api/revisions/b9942a13e3b2/schema)