Skip to support content

Getting started

Take your first screenshot

Create an API key, make a capture request, and choose how to receive the image.

Capture in the dashboard

  1. Sign in to the dashboard and select the organization you want to use.
  2. Open Screenshots → Playground, enter a full public website URL, and choose the viewport and output format.
  3. Capture the page and inspect the result. Use a simple page first so you can distinguish setup problems from site-specific problems.

Capture with the API

Create a key in API Keys. Store it in an environment variable on your server. The full key is shown when it is created; the short identifier shown later is not a usable API key.

Shell example
curl -X POST "https://api.allscreenshots.com/v1/screenshots" \
  -H "X-API-Key: $ALLSCREENSHOTS_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com","format":"png"}' \
  --output screenshot.png

Choose the response

A binary response returns the file itself. Use responseType: "url" for a JSON response containing a stored download URL, or responseType: "base64" for inline image data. Check the HTTP status before saving the body as an image: an error response contains JSON.

Documentation

Related support articles

Need help with this issue?

Email support with this article, your request or capture ID, and the result you expected. Remove credentials and private information first.

Email [email protected]
Back to support