How to Generate an API Key in PeekShot

API keys let you call PeekShot programmatically from your own apps, scripts, or automation tools. This guide shows you how to create and manage API keys using the Account → API Keys tab.

Step 1: Open the Account Settings Page

1. From the sidebar, click Account (this opens the Account page in your dashboard).

2. At the top, you’ll see horizontal tabs for Profile, API Keys, and Redeem Coupon.

Step 2: Switch to the API Keys Tab

1. Click the API Keys tab (with the key icon).

2. The panel updates to show the API key management UI, where you can create and view keys.

Step 3: Create a New API Key

Inside the API Keys tab:

1. Click the Create API Key or similar button (the UI will show a primary action to add a new key).

2. Optionally, enter a name or label (for example, "Server-side app", "Zapier integration"), depending on your configuration.

3. Confirm creation. PeekShot will generate a new API key value for you.

Step 4: Copy and Store Your API Key

Once the key is created:

• The API key is shown in the list, often masked for security.

• Use the copy icon or button next to the key to copy it to your clipboard.

• Paste and store it securely in an environment variable or secrets manager (for example, PEEKSHOT_API_KEY in your backend).

Important: Treat API keys as secrets. Do not commit them to Git, share them publicly, or embed them in client-side code.

Step 5: Use the API Key in Your Requests

When calling PeekShot’s API endpoints (for example, to take a screenshot):

• Include the key as a header: x-api-key: YOUR_API_KEY_HERE

• Use HTTPS endpoints such as POST https://api.peekshot.com/api/v1/screenshots or POST https://api.peekshot.com/api/v1/html-to-image depending on your use case.

Step 6: Rotate or Delete Keys When Needed

Over time you might want to revoke old keys or rotate them for security:

• Deactivate or delete: Use the controls in the API Keys tab to disable or delete an existing key you no longer use.

• Create a replacement: Generate a new key first, update your apps to use it, then revoke the old one.

Best Practices for API Keys

• Use separate keys for environments: Create different keys for development, staging, and production.

• Limit who can see keys: Only share keys with team members who need them.

• Rotate periodically: Plan to rotate keys regularly and after any suspected leak.