Skip to content

Getting started

Quick start

Create a key and capture your first screenshot in under a minute.

1. Create an account

Sign up for free. Every account includes 100 credits per month — no credit card required.

2. Create an API key

In the dashboard, open API Keys → Create key. Give it an alias (for example "Local development") and a category, then copy the key. It's shown only once.

Store it in an environment variable:

export SNAPLENS_API_KEY="your_api_key"
curl -G "http://localhost:4000/v1/capture" \
  --data-urlencode "url=https://example.com" \
  -H "x-api-key: $SNAPLENS_API_KEY" \
  -o example.png

Open example.png — that's a 1920×1080 PNG of the page.

4. Customize the capture

Add query parameters to change the output:

curl -G "http://localhost:4000/v1/capture" \
  --data-urlencode "url=https://example.com" \
  -d format=webp \
  -d full_page=true \
  -d device=iphone_14_pro \
  -d remove_cookie_banners=true \
  -H "x-api-key: $SNAPLENS_API_KEY" -o example.webp

Every parameter is listed in the capture reference.

5. Extract content or analyze

The same key works for the other APIs:

# Markdown + metadata + links
curl -G "http://localhost:4000/v1/content" --data-urlencode "url=https://example.com" \
  -d include_markdown=true -H "x-api-key: $SNAPLENS_API_KEY"

# AI analysis (paid plans)
curl -G "http://localhost:4000/v1/analyze" --data-urlencode "url=https://example.com" \
  -H "x-api-key: $SNAPLENS_API_KEY"
curl "http://localhost:4000/v1/usage" -H "x-api-key: $SNAPLENS_API_KEY"

What's next