SNAPSHOT

API Reference

Overview

Authentication

Snapshot APIs are secured using an API Key. Every API request must include a valid API-KEY header. Requests without a valid API Key will be rejected with an Unauthorized response. The API Key uniquely identifies your workspace and is used to authenticate every request made to the Snapshot API.

To obtain your API Key

  1. Sign in to your Snapshot Dashboard using your account credentials.
  2. Navigate to Dashboard.
  3. Copy your Workspace API Key.
  4. Include the API Key in the API-KEY request header for every API call.

Important Notes

  • • Every workspace has its own unique API Key.
  • • Keep your API Key confidential and never expose it in client-side applications or public repositories.
  • • If you believe your API Key has been compromised, regenerate it from the Dashboard immediately. The previous API Key will become invalid.
  • • The same API Key is used across all Snapshot APIs, including Screenshots, Schedules, Reports, and Activity APIs.
  • • All API usage, wallet deductions, quotas, and reports are associated with the workspace identified by the supplied API Key.

Headers

NameRequiredTypeDescription
API-KEYYesstringWorkspace API key
AcceptNostringapplication/json

Authentication Example

API-KEY: your_workspace_api_key

curl https://snapshot-api.mindiqglobal.com/api/v1/screenshot \
  -H "API-KEY: your_workspace_api_key" \
  -H "Accept: application/json"