WebShot – APIVult

Docs

WebShot

Web page screenshot and PDF generation API. Capture full-page screenshots, generate PDFs from URLs, and process multiple pages in batch.

Overview

WebShot renders web pages in a headless browser and returns screenshots or PDFs. Supports custom viewports, full-page capture, and batch processing.

Base URL: https://api.apivult.com/v1/dev/screenshot

Authentication

Include your API key in every request header: X-API-Key: YOUR_API_KEY

Endpoints

Method	Endpoint	Description
POST	`/v1/dev/screenshot/screenshot`	Capture a screenshot of a URL
POST	`/v1/dev/screenshot/pdf`	Generate a PDF from a URL
POST	`/v1/dev/screenshot/batch`	Process multiple URLs in one request (up to 10)

Screenshot Options

Parameter	Type	Default	Description
`url`	string	required	Target URL
`width`	integer	`1280`	Viewport width in pixels
`height`	integer	`800`	Viewport height in pixels
`full_page`	boolean	`false`	Capture full scrollable page
`format`	string	`png`	Output format: `png` or `jpeg`
`delay`	integer	`0`	Wait time in ms before capture

Quick Start

curl -X POST "https://api.apivult.com/v1/dev/screenshot/screenshot" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "width": 1280,
    "height": 800,
    "full_page": true,
    "format": "png"
  }'

Response:

{
  "screenshot_id": "shot_xyz789",
  "format": "png",
  "width": 1280,
  "height": 3200,
  "download_url": "https://api.apivult.com/v1/dev/screenshot/download/shot_xyz789",
  "expires_at": "2024-03-16T10:30:00Z",
  "size_bytes": 182400
}

Rate Limits

Plan	Requests/Month
Free	500
Basic	1,000
Pro	10,000

DocForge Rate Limits