Getting Started with PeekShot API

Introduction

Welcome to PeekShot!

If you're a developer, marketer, agency, or creator who needs clean, high-quality website screenshots for reports, monitoring, or archiving — you’re in the right place.

PeekShot is an API-first website screenshot tool that lets you automate and streamline website screenshots with just a few simple API calls.

In this guide, we'll walk you through how to get started with the PeekShot API — step by step — so you can easily capture full page screenshots, automate reports, and build better workflows. 🚀

Step 1: Sign Up for a Free PeekShot Account

First, head over to peekshot.com and create a free account. You can sign up using:

• Your email & password
• Google Sign-In for a faster signup process

Once you’re inside the dashboard, you’re ready to start using our website screenshot API!

Step 2: Grab Your API Key (For Authentication)

Your API key is required to authenticate all your PeekShot API requests.

In the PeekShot dashboard, navigate to the API Key section. Copy the API key — you’ll use this key in the headers of every API request to securely access the PeekShot screenshot API.

🔒 Tip: Keep your API key private and secure.

Step 3: Configure Your Screenshot (Using Playground)

Not sure how you want to configure your screenshot? We’ve made it easy!

Go to the Playground section in your dashboard. Experiment with various screenshot options like:

• Capture full-page screenshots
• Mobile vs Desktop view
• Custom viewport sizes
• Delays before capture
• Custom user agents

Once you’ve selected the desired settings, copy the auto-generated request payload — it’s ready to be used in your automated website screenshot API call.

Note: The Playground covers the most common options. For advanced settings — such as emulating a device, injecting custom CSS or JavaScript — refer to our API documentation for the complete list of capabilities.

Step 4: Make Your First Screenshot API Request

Now it’s time to take a website screenshot programmatically using our REST API!

You can trigger a screenshot using Postman or directly from your app.

API Endpoint:
POST https://api.peekshot.com/api/v1/screenshots

Headers:
x-api-key: YOUR_API_KEY

Body:
Paste the payload you copied from the Playground (or modify it using the API docs for more advanced options).

Once you send the request, you’ll receive a request ID in the response — this helps you track the screenshot status.

Step 5: Check Screenshot Status (And Get Your Screenshot)

To check if your screenshot is ready, use the screenshot status API:

API Endpoint:
GET https://api.peekshot.com/api/v1/screenshots/:requestId

Headers:
x-api-key: YOUR_API_KEY

Replace :requestId with the ID from the earlier response and hit Send.

If the status is "COMPLETE", you’ll receive a screenshotUrl — a secure link to your screenshot hosted on S3. You can access and view your screenshot directly using this URL. (If you wish, you can manually download the image from the link on your end.)

Recap: The Simple 4-Step Workflow

• Sign Up & Get API Key
• Configure Screenshot (Playground)
• Trigger API Request
• Track Status & Access Screenshot URL

Why Choose PeekShot for Website Screenshots?

• Capture full-page screenshots on desktop & mobile
• Automate website screenshots for reports and monitoring
• Advanced API options for precision and customization
• Secure and reliable screenshot processing, even on dynamic pages
• Easy-to-use dashboard to manage your API keys and requests

Start Capturing the Web — The Smarter Way

• ✨ Try PeekShot today — sign up at peekshot.com
• 📚 Explore our API documentation — PeekShot API Docs
• 🤝 Got questions? Reach out to us at [email protected]