Documentation Screenshot API

Screenshot API for developer docs and knowledge bases

Capture API reference pages, release notes, and help center articles from public URLs with one hosted screenshot request. Scrnpix handles browser rendering so docs teams can focus on shipping accurate visual documentation.

API reference pages

Archive endpoint, authentication, and SDK pages before a release note or migration guide ships.

Knowledge base articles

Generate consistent article screenshots for support docs, internal portals, and enablement decks.

Docs release workflows

Capture public preview URLs from CI so changelogs and launch docs have current product visuals.

Exact API example for docs capture

This request captures a full-page PNG of a public API recipe page and saves it as a reusable docs asset.

cURL
curl "https://api.scrnpix.com/screenshot?url=https%3A%2F%2Fwww.scrnpix.com%2Fdocs%2Frecipes%2Fbasic-screenshot&width=1440&height=1200&full_page=true&format=png" \
  -H "X-KEY: your-api-key" \
  -o basic-screenshot-docs.png

What the request does

  • Captures the public Scrnpix basic screenshot recipe at 1440 pixels wide.
  • Uses full_page=true so long reference pages are saved as one image.
  • Returns image bytes directly and writes the PNG to basic-screenshot-docs.png.
  • Costs 1 screenshot credit; the response includes X-Credit-Cost for tracking.

Good fit

  • Public API docs, changelogs, docs previews, and support knowledge bases.
  • Docs teams that need current screenshots without managing Playwright workers.
  • Developer relations and support teams that reuse screenshots across guides.

Boundaries

  • Private docs portals still need a public preview URL or your own authenticated browser flow.
  • Scrnpix returns the capture; annotation, image review, and docs publishing stay in your pipeline.
  • Consent banners and public overlays render if they appear to a normal visitor.

Supporting recipes and tools

Start with the docs-oriented request above, then use these pages for capture parameters, full-page behavior, and manual checks.

Add current screenshots to your docs pipeline

Start with a public docs URL, confirm the capture in the playground, then call the same endpoint from your release or docs build automation.