This quickstart walks through the essentials for calling the Atomscale API with the Python SDK.
Prerequisites
- Python 3.10 through 3.12
- An active Atomscale account
- An API key from the Atomscale Dashboard (found in User >
Manage Account > Access)
Install the client
Create a client
The Client reads AS_API_KEY and AS_API_ENDPOINT from the environment. Export the variables or pass values explicitly.
import os
from atomscale import Client
os.environ["AS_API_KEY"] = "YOUR_API_KEY"
client = Client()
Never commit your API key to version control. Use environment variables or a secrets manager.
client = Client(
api_key="YOUR_API_KEY",
endpoint="https://api.atomscale.ai/",
)
Verify the connection
Run a simple search to confirm the client is working:
results = client.search()
print(f"Found {len(results)} items in the catalogue")
Mute progress bars
For non-interactive environments like CI pipelines, pass mute_bars=True:
client = Client(api_key="YOUR_API_KEY", mute_bars=True)
Next steps
