Authentication

​

Obtaining an API Key

1. Log in to the Atomscale Dashboard
2. Click your name at the bottom of the sidebar, then select Manage account > Access
3. Enter a Label (optional) to identify the key, and choose an Expiration (see Key Expiration)
4. Click Generate API Key
5. Copy and securely store the key. It is only shown once.

​

Using Your API Key

X-API-KEY: YOUR_API_KEY

​

Code Examples

from atomscale import Client

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

import requests

headers = {
    "X-API-KEY": "YOUR_API_KEY"
}

response = requests.get(
    "https://api.atomscale.ai/data_entries/",
    headers=headers
)

curl https://api.atomscale.ai/data_entries/ \
  -H "X-API-KEY: YOUR_API_KEY"

​

Environment Variables

import os

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

export AS_API_KEY="your_api_key_here"

​

Key Permissions

​

Key Expiration

• When you generate a key, you can set it to expire after 7, 30, 60, or 90 days, or never. The default is 90 days.
• A banner at the top of the dashboard warns you when a key will expire within 14 days.
• A key that goes unused for 90 days is revoked automatically, whatever expiration you chose.
• Generating a new key immediately expires your previous key. Update any applications that use the old key.
• Requests made with an expired or revoked key return 401 Unauthorized.

​

Revoking Keys

1. Open the Access page (click your name at the bottom of the sidebar, then select Manage account > Access)
2. Find the key and click Revoke, then click Revoke again to confirm
3. The key is immediately invalidated