SDK Installation

Install the RadMah AI SDK for your language, authenticate with your API key, and verify the connection in under five minutes.

Requirements

Language	Minimum Version	Package Manager
Python	3.10+	`pip`
REST API	Any	`cURL` / any HTTP client

You also need a RadMah AI API key (prefixed sl_live_). Create one from Settings → API Keys in the dashboard.

Install the SDK

Install

pip install radmah-sdk

✦Python extras

For Jupyter notebook workflows, install with the optional pandas dependency: pip install radmah-sdk pandas. The SDK works without pandas, but to_dataframe() requires it and raises a clear error if missing.

Configure Environment Variables

The Python SDK reads these environment variables automatically. Set them in your shell profile, CI secrets, or container environment.

Variable	Required	Description
RADMAH_API_KEY	Yes	Your API key. Prefixed `sl_live_`
RADMAH_BASE_URL	No	Override the API endpoint. Defaults to `https://api.radmah.ai`
RADMAH_TIMEOUT	No	Request timeout in seconds. Defaults to `120`

.env / shell

export RADMAH_API_KEY="sl_live_your_key_here"

# Optional overrides
export RADMAH_BASE_URL="https://api.radmah.ai"
export RADMAH_TIMEOUT="120"

⚠Never hardcode API keys

Do not commit API keys to source control. Use environment variables, a secrets manager, or your CI/CD platform's secret storage. The SDK reads RADMAH_API_KEY from the environment automatically when no key is passed to the constructor.

Initialize the Client

Create a client instance. If RADMAH_API_KEY is set in the environment, the constructor picks it up automatically. You can also pass configuration explicitly.

Client initialization

from radmah_sdk import RadMahClient

# Reads RADMAH_API_KEY from environment
client = RadMahClient()

# Or pass configuration explicitly
client = RadMahClient(
    api_key="sl_live_your_key_here",
    base_url="https://api.radmah.ai",
    timeout=120,
)

✦Enterprise deployments

For on-premise or VPC deployments, set RADMAH_BASE_URL to your private API endpoint. The Python SDK reads this automatically. For REST API usage, replace the base URL in your requests.

Verify Connection

Run this quick verification to confirm your SDK is installed, your API key is valid, and the client can reach the RadMah AI API.

Verify connection

from radmah_sdk import RadMahClient

client = RadMahClient()

# Fetch account info to verify the connection
account = client.account.get()
print(f"Connected as: {account.name}")
print(f"Tenant:       {account.tenant_id}")
print(f"Plan:         {account.plan}")

If the connection succeeds, you will see your account name, tenant ID, and plan printed to the console. If it fails, the SDK throws an authentication error with a descriptive message.

Configuration Reference

All Python SDK client options can be set via constructor parameters or environment variables. Constructor parameters take precedence over environment variables.

Parameter	Env Variable	Default	Description
api_key	RADMAH_API_KEY	—	API key for authentication. Required.
base_url	RADMAH_BASE_URL	https://api.radmah.ai	API base URL. Override for enterprise deployments.
timeout	RADMAH_TIMEOUT	120	Request timeout in seconds.
max_retries	RADMAH_MAX_RETRIES	3	Maximum retry attempts for transient failures.
verify_ssl	RADMAH_VERIFY_SSL	true	TLS certificate verification. Do not disable in production.

SDK Resource Namespaces

The Python SDK client exposes resource namespaces for each area of the platform. The same resources are available via REST endpoints.

Namespace	Description
client.account	Account info, usage, and plan details
client.jobs	Create, list, get, cancel, and rerun generation jobs
client.datasets	Upload, list, get, and delete datasets
client.artifacts	List, download, and verify job artifacts and evidence bundles
client.seals	List, get, and download provenance seals
client.connectors	CRUD, test, import from, and deliver to external sources
client.agent	Agentic Data Scientist project lifecycle

Next Steps

Authentication — API key management, JWT sessions, and security best practices
Running Jobs — Job creation, monitoring, and lifecycle
Evidence Bundles — Download and verify provenance evidence
REST API Reference — Full endpoint documentation