Reference
Glossary
Definitions of the terms used throughout the documentation.
| Term | Definition |
|---|---|
| API key | Secret sent in the x-api-key header to authenticate requests. Belongs to a workspace; has an alias, category, optional expiry and quotas. |
| Async job | A request made with is_async=true. Returns a job_id immediately and runs in the background. |
| Auto top-up | Automatic purchase of a credit pack when the balance falls below a threshold. |
| Billing period | The interval after which the subscription quota resets (monthly). |
| Cache hit / miss | Whether a response was served from cache (x-cache: HIT) or rendered (MISS). |
| Cache TTL | How long a cached response is kept, in seconds (cache_ttl, max 30 days). |
| Credit | Unit of billing. One successful billable request costs one credit. |
| Credits ledger | Credits granted to a workspace outside of plans and packs, consumed after packs. |
| Defuddle | Main-content extraction that removes navigation, sidebars, footers and comments (use_defuddle). |
| Device profile | A preset viewport, pixel ratio, user agent and touch setting (device). |
| Full page | A capture of the entire document height rather than the viewport (full_page). |
| Merchant of record | The company legally selling to you and handling payments and taxes — Dodo Payments for ScreenshotDude. |
| MCP | Model Context Protocol — the standard AI clients use to call external tools. See MCP server. |
| Overage | Requests beyond your included credits on a paid plan, billed per credit at your plan's rate. |
| Pack | One-time bundle of credits, valid 12 months, consumed after the subscription quota. |
| Plan rate limit | Maximum requests per second and per minute for your workspace. Exceeding it returns 401 Rate limit exceeded: …. |
| Quota (per key) | Optional cap on a key's requests over a total, daily, weekly or monthly window. |
| Scale factor | Device pixel ratio (1–3) for high-resolution captures. |
| Selector | CSS selector identifying an element to capture or to wait for. |
| soft_fail | Global parameter that turns errors into 200 responses with an error field. |
| Stealth mode | Browser fingerprint hardening to reduce bot detection (stealth, paid plans). |
| Subscription quota | Credits included in your plan for the current billing period. |
| Viewport | The visible browser area, set with viewport_width and viewport_height (default 1920×1080). |
| Webhook | HTTP POST we send to your webhook_url when an async job finishes, signed with x-snaplens-signature. |
| Workspace | Your account's organization: members, keys, balances and billing. |