# scrnshot

> Developer documentation for the scrnshot screenshot API.

## Docs

- [Create an API key](https://docs.scrnshot.site/api-reference/api-keys/create-an-api-key.md): Dashboard-only — session cookie auth. The plaintext key is returned exactly once in this response; only its prefix and metadata are retrievable afterward. Store it immediately.
- [List API keys](https://docs.scrnshot.site/api-reference/api-keys/list-api-keys.md): Dashboard-only — session cookie auth. Never returns plaintext key material, only prefix and metadata.
- [Revoke an API key](https://docs.scrnshot.site/api-reference/api-keys/revoke-an-api-key.md): Dashboard-only — session cookie auth. Immediately invalidates the key for authentication.
- [Get subscription status](https://docs.scrnshot.site/api-reference/billing/get-subscription-status.md): Dashboard-only — session cookie auth. Current plan, subscription status, and renewal date.
- [Start a Pro checkout](https://docs.scrnshot.site/api-reference/billing/start-a-pro-checkout.md): Dashboard-only — session cookie auth. Creates a checkout session with scrnshot's payment provider for the authenticated account and returns a link to complete payment.
- [Anonymous demo capture](https://docs.scrnshot.site/api-reference/demo/anonymous-demo-capture.md): **Not for integration.** Powers the live "try it" widget on scrnshot.site. No authentication; rate-limited by client IP (5/day). Fixed PNG output at 1280×720. Use `POST /v1/screenshots` with an API key for real usage.
- [Capture a screenshot](https://docs.scrnshot.site/api-reference/screenshots/capture-a-screenshot.md): Renders `url` and returns a hosted image. Every request — cache hit or miss — counts against the monthly quota. Results are cached for ~15 minutes per unique combination of URL and capture options; Pro plans can force a fresh render with `fresh: true`. See [Caching & fresh](/guides/caching-and-fresh…
- [Delete a screenshot](https://docs.scrnshot.site/api-reference/screenshots/delete-a-screenshot.md): Removes the database record and the stored image. Ownership is enforced — you can only delete your own screenshots.
- [List screenshots](https://docs.scrnshot.site/api-reference/screenshots/list-screenshots.md): Returns screenshots captured by the authenticated account, most recent first.
- [Get current usage](https://docs.scrnshot.site/api-reference/usage/get-current-usage.md): Current-period quota consumption, for dashboard usage charts or programmatic monitoring.
- [Authentication](https://docs.scrnshot.site/authentication.md): API keys, the X-API-Key header, and revocation
- [Caching & fresh](https://docs.scrnshot.site/guides/caching-and-fresh.md): How results are cached, and when a request counts against quota
- [Errors](https://docs.scrnshot.site/guides/errors.md): Status codes, response shapes, and how to handle each one
- [Plans & limits](https://docs.scrnshot.site/guides/plans-and-limits.md): Demo, Free, and Pro — quotas, rate limits, formats, and retention
- [Screenshot options](https://docs.scrnshot.site/guides/screenshot-options.md): Every parameter accepted by POST /v1/screenshots, its default, and which plans can use it
- [Introduction](https://docs.scrnshot.site/index.md): What scrnshot is and how the API is organized
- [Quickstart](https://docs.scrnshot.site/quickstart.md): Create an account, get an API key, capture your first screenshot

## OpenAPI Specs

- [openapi](https://docs.scrnshot.site/api-reference/openapi.yaml)