vee3-io Website Screenshot API
The website-screenshot API from vee3-io — 1 operation(s) for website-screenshot.
The website-screenshot API from vee3-io — 1 operation(s) for website-screenshot.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
find_apisBrowse and filter every API in the catalog.get_api_artifactsOne API's artifacts, grouped by type.get_openapiThe primary OpenAPI for this API.find_similar_apisAPIs that look like this one.apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.resolveTurn a domain, URL or GitHub org into the provider it belongs to.find_cohortsEvery scored population of providers in the catalog.curl "https://apis.io/api/v1/apis/vee3-io:vee3-io-website-screenshot-api"
curl "https://apis.io/api/v1/apis?limit=25"
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.
A second provider on the same verified email joins the account you already have.
openapi: 3.2.0
info:
title: Vee3 Io Website Screenshot API
version: 0.1.0
description: 'Operations tagged website-screenshot across 2 of this provider''s published API definitions: vee3-io.json, vee3-io-openapi.json. Each path carries the servers of the definition it was published in.'
tags:
- name: website-screenshot
paths:
/v1/website-screenshots/screenshot:
post:
tags:
- website-screenshot
summary: Website screenshots
description: Capture any public URL - viewport, full page, signed PNG or JPEG.
operationId: create_website_screenshot_v1_website_screenshots_screenshot_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ScreenshotRequest'
required: true
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/ScreenshotResult'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
security:
- HTTPBearer: []
components:
schemas:
ScreenshotResult:
properties:
screenshot_id:
type: string
title: Screenshot Id
status:
type: string
title: Status
default: completed
url:
type: string
title: Url
screenshot_url:
type: string
title: Screenshot Url
file_name:
type: string
title: File Name
viewport_width:
type: integer
title: Viewport Width
viewport_height:
type: integer
title: Viewport Height
full_page:
type: boolean
title: Full Page
dark_mode:
type: boolean
title: Dark Mode
default: false
block_cookie_banners:
type: boolean
title: Block Cookie Banners
default: false
format:
type: string
title: Format
default: png
quality:
anyOf:
- type: integer
- type: 'null'
title: Quality
file_size_bytes:
type: integer
title: File Size Bytes
retained_until:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Retained Until
created_at:
type: string
format: date-time
title: Created At
download_code:
type: string
title: Download Code
download_id:
type: string
title: Download Id
expires_at:
type: string
format: date-time
title: Expires At
install_command:
type: string
title: Install Command
command:
type: string
title: Command
troubleshooting:
type: string
title: Troubleshooting
type: object
required:
- screenshot_id
- url
- screenshot_url
- file_name
- viewport_width
- viewport_height
- full_page
- file_size_bytes
- created_at
- download_code
- download_id
- expires_at
- install_command
- command
- troubleshooting
title: ScreenshotResult
ScreenshotRequest:
properties:
url:
type: string
maxLength: 2048
title: Url
description: Public http or https URL to capture. Private, localhost, and internal network addresses are blocked.
full_page:
anyOf:
- type: boolean
- type: 'null'
title: Full Page
description: Capture the full scrollable page. When false, only the viewport area is captured.
default: false
viewport_width:
anyOf:
- type: integer
maximum: 3840.0
minimum: 320.0
- type: 'null'
title: Viewport Width
description: Browser viewport width in pixels.
default: 1280
viewport_height:
anyOf:
- type: integer
maximum: 2160.0
minimum: 240.0
- type: 'null'
title: Viewport Height
description: Browser viewport height in pixels.
default: 720
wait_until:
type: string
enum:
- load
- domcontentloaded
- networkidle
title: Wait Until
description: 'When to take the screenshot: ''load'' (load event), ''domcontentloaded'' (DOM ready, faster; use with post_load_wait to let the page settle), or ''networkidle'' (no network activity for 500ms; can time out on pages with ongoing requests).'
default: domcontentloaded
timeout_seconds:
anyOf:
- type: integer
maximum: 60.0
minimum: 5.0
- type: 'null'
title: Timeout Seconds
description: Maximum seconds to wait for the page to load before failing.
default: 30
post_load_wait:
anyOf:
- type: integer
maximum: 20.0
minimum: 0.0
- type: 'null'
title: Post Load Wait
description: Extra seconds to wait after wait_until before capturing. Only valid when wait_until is domcontentloaded. Use this instead of networkidle when pages keep network activity.
default: 0
format:
type: string
enum:
- png
- jpeg
title: Format
description: Output image format. 'png' preserves lossless quality (default). 'jpeg' produces smaller files.
default: png
quality:
anyOf:
- type: integer
maximum: 100.0
minimum: 0.0
- type: 'null'
title: Quality
description: JPEG compression quality from 0 (smallest) to 100 (best). Only applies when format is 'jpeg'; ignored for PNG.
default: 80
dark_mode:
anyOf:
- type: boolean
- type: 'null'
title: Dark Mode
description: 'When true, emulate prefers-color-scheme: dark so sites with dark-mode CSS render in dark mode. Has no effect on sites without dark-mode styling.'
default: false
block_cookie_banners:
anyOf:
- type: boolean
- type: 'null'
title: Block Cookie Banners
description: When true, attempt to dismiss common cookie consent banners and overlays before capture. Best-effort - custom or first-party banners may remain.
default: false
file_name:
anyOf:
- type: string
maxLength: 255
- type: 'null'
title: File Name
description: Optional account-relative storage path for the screenshot. If omitted, the file is stored under downloads/ with a generated name.
type: object
required:
- url
title: ScreenshotRequest
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
type: array
title: Location
msg:
type: string
title: Message
type:
type: string
title: Error Type
input:
title: Input
ctx:
type: object
title: Context
type: object
required:
- loc
- msg
- type
title: ValidationError
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
type: array
title: Detail
type: object
title: HTTPValidationError
securitySchemes:
HTTPBearer:
type: http
scheme: bearer
x-refined-from:
- vee3-io.json
- vee3-io-openapi.json