Stepshots logoStepshots

API Keys

Generate and manage API keys for the Stepshots CLI, browser extension, and CI integrations.

Overview

API keys authenticate the Stepshots CLI and browser extension when uploading demos to your workspace. You need an API key for:

  • Uploading demos from the CLI (stepshots upload)
  • Uploading demos from the browser extension
  • Integrating with external tools and workflows

Generate an API Key

  1. Sign in to your Stepshots dashboard
  2. Open Settings
  3. Click Generate API Key
  4. Copy the key immediately

Using Your API Key

CLI

Pass the key directly:

bash
stepshots upload output/my-demo.stepshot --token YOUR_API_KEY

Or set it as an environment variable (recommended):

bash
export STEPSHOTS_TOKEN=YOUR_API_KEY
stepshots upload output/my-demo.stepshot

Browser Extension

  1. Open the Stepshots extension side panel
  2. Go to Settings
  3. Paste your Stepshots URL and API Key
  4. Save

The extension uses the key to upload recordings directly to your workspace.

Environment Variables

The CLI recognizes these environment variables:

Variable Description
STEPSHOTS_TOKEN API key for authentication (required for upload)
STEPSHOTS_SERVER Override the server URL (default: https://stepshots.com)
CHROME_PATH Path to Chrome/Chromium binary (if not in the default location)

Revoking a Key

To revoke an API key, open Settings in the dashboard and delete the key. Any CLI or extension using that key will immediately lose upload access.

Generate a new key and update your CI secrets or extension settings.

Navigation