Quick Start

Get your first screenshot in under 2 minutes. This guide will walk you through the basics.

1. Get your API Key

First, sign up for a free account and grab your API key from the dashboard.

Your API keys will look like this:

• Live key: rs_live_xxxxxxxxxxxxx - for production use
• Test key: rs_test_xxxxxxxxxxxxx - for development (free, unlimited)

2. Make your first request

The simplest way to capture a screenshot is with a GET request:

curl "https://api.renderscreenshot.com/v1/screenshot?url=https://example.com&api_key=rs_test_xxxxx"

Or use the POST endpoint for more control:

curl -X POST https://api.renderscreenshot.com/v1/screenshot \
  -H "Authorization: Bearer rs_test_xxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com",
    "preset": "og_card"
  }'

3. Use presets for common sizes

We offer presets for common use cases:

4. Add to your HTML

Use the screenshot URL directly in your meta tags:

<meta property="og:image"
      content="https://api.renderscreenshot.com/v1/screenshot?url=https://yoursite.com&preset=og_card&api_key=rs_live_xxxxx" />

Next Steps

• Learn about authentication options
• Explore all parameters
• See the full POST endpoint reference