Skip to main content

API key authentication

All Snipp API endpoints require authentication. Include your API key in the api-key header with every request.
api-key: YOUR_API_KEY

Where to find your API key

  1. Sign in at snipp.gg.
  2. Go to Settings.
  3. Copy your API key from the API section.

Examples

curl -X GET "https://api.snipp.gg/users/@me" \
  -H "api-key: YOUR_API_KEY"

API key permissions

Not all API keys have the same permissions. When you view your key in settings, you’ll see whether it has upload access enabled:
PermissionDescription
ReadFetch your profile, list uploads, browse discover. Always enabled.
UploadUpload files and delete uploads. Can be toggled in settings.
You can check your key’s permissions by calling GET /users/@me and looking at the keyHasUploadsAccess field.

Security best practices

  • Never expose your API key in client-side code, public repositories, or shared documents.
  • Use environment variables in production (e.g. process.env.SNIPP_API_KEY).
  • Rotate your key immediately if you suspect it has been compromised. You can regenerate it from your account settings.
  • Limit upload access if your integration only needs read access.

Error responses

StatusCause
401Missing api-key header
401Invalid or expired API key
403Account suspended or insufficient permissions
All errors return a JSON object with an error field describing the issue.