BiGapiguides
POST /v1/screenshot → 200 image/png · 1¢

Website screenshot API — one POST, one PNG

Full-page or viewport capture of any public URL with device presets. The simple front door agents search for: no browser pool to run, no Puppeteer to maintain.

Quick start (curl)

Get a key first – no signup: curl -X POST https://api.bigapi.dev/v1/keys (100 free operations, 7 days).

curl -X POST https://api.bigapi.dev/v1/screenshot -H 'Authorization: Bearer $KEY' -H 'Content-Type: application/json' -d '{"url":"https://example.com","device":"mobile"}' -o shot.png

Give it to your agent (MCP)

Add BiGapi to Claude Desktop, Cursor or any MCP client – the server fetches its own key on first use:

{
  "mcpServers": {
    "bigapi": { "command": "npx", "args": ["-y", "@bigapi/mcp"] }
  }
}

Then simply ask: “Take a mobile screenshot of bigapi.dev and show it to me.” – the model calls the screenshot tool.

When your agent needs this

Parameters

ParamTypeRequiredNotes
urlstringyesPublic URL to capture.
devicestringnoViewport preset; mobile/tablet use touch + high DPI. – one of desktop, laptop, tablet, mobile · default desktop
fullPagebooleannoCapture the whole page instead of just the viewport. – default True
formatstringnoone of png, jpeg · default png
qualityintegernoJPEG quality 30–100. – default 85
widthintegernoOverride viewport width (px).
heightintegernoOverride viewport height (px).
delayMsintegernoExtra wait after load, up to 10000 ms.

Pricing

per operation
First 100 operations free (per key, 7 days) · failed calls (4xx/5xx) cost $0 · repeats with Idempotency-Key are free · prepaid credit from $5, never expires.

Every response carries X-BigAPI-Cost, X-BigAPI-Balance and X-BigAPI-Free-Ops – your agent can budget on its own.

Errors your agent can handle

StatusMeaningAgent action
401missing/invalid keyPOST /v1/keys for a fresh one
402credit exhaustedshow the upgrade_url from the response to a human
413file too largesplit the input (limit 100 MB)
422conversion failedcheck the detail field – costs $0
429rate limitedwait retry_after seconds

FAQ

Which devices are available?

desktop (1440×900), laptop (1280×800), tablet (834×1112 @2x) and mobile (390×844 @3x, touch enabled). Override width/height freely.

Full page or just the viewport?

fullPage=true (default) captures the whole scroll height; set false for the viewport only.

JPEG or PNG?

PNG by default. format=jpeg with quality 30–100 for smaller files.