Authentication

Manage API keys and authenticate your requests.

Every request to the Pulse API requires an API key. Keys are passed via the X-API-Key header. The Python SDK handles this for you.

Getting your API key

Sign in to your Dashboard and click Create new key. You can create multiple keys and label them for different environments or team members.

API keys are only shown once at creation. If you lose a key, revoke it and create a new one.

Using your key in the SDK

Pass the key directly to the client:

python
from simudyne import PulseABM

client = PulseABM(api_key="pk_live_...")

Using an environment variable

Set SIMUDYNE_API_KEY and the SDK will pick it up automatically:

bash
export SIMUDYNE_API_KEY=pk_live_...
python
from simudyne import PulseABM

client = PulseABM()  # reads from SIMUDYNE_API_KEY

Using environment variables is recommended for production scripts and CI/CD pipelines. Avoid hardcoding keys in source code.

Key format

API keys start with pk_live_ followed by a random hex string. Only the prefix is stored on our servers. We never store the full key.

Revoking a key

You can revoke keys from the Dashboard or programmatically through the SDK. See API key management.

Download data→