Skip to main content
All API requests require authentication. The Atomscale API uses API key authentication via the X-API-KEY header.

​
Obtaining an API Key

  1. Log in to the Atomscale Dashboard
  2. Navigate to User > Manage Account > Access
  3. Click Generate API Key
  4. Copy and securely store the key
Treat your API keys like passwords. Never commit them to version control or share them publicly.

​
Using Your API Key

Include your API key in the X-API-KEY header of every request: 
X-API-KEY: YOUR_API_KEY

​
Code Examples

from atomscale import Client

# The SDK handles authentication automatically
client = Client(api_key="YOUR_API_KEY")

​
Environment Variables

For security, store your API key in an environment variable rather than hardcoding it: 
import os

api_key = os.environ.get("ATOMSCALE_API_KEY")

​
Key Permissions

API keys can be scoped to specific permissions:
PermissionDescription
readRead access to data and analysis results
writeCreate and modify data entries, projects, and samples
deleteDelete data entries and resources
adminFull access including team management

​
Revoking Keys

If a key is compromised or no longer needed:
  1. Go to Settings > API Keys in the dashboard
  2. Find the key and click Revoke
  3. The key is immediately invalidated
Revoking a key cannot be undone. Any applications using that key will stop working immediately.