​
Authentication

To use the NomadicML API, you need to authenticate your requests using an API key. This guide covers obtaining and using API keys with both the SDK and direct HTTP requests.

​
Obtaining an API Key

Generate API keys from the NomadicML web platform:
  1. Log in to your account at app.nomadicml.com
  2. Navigate to your profile by clicking your avatar in the top-right corner
  3. Select API Keys from the menu
  4. Click Generate New Key
  5. Enter a descriptive name for your key
  6. Select the expiration period (default is 90 days)
  7. Click Create Key
The full API key is only shown once when generated. Copy and store it securely. Lost keys cannot be recovered and must be regenerated.

​
Using the Python SDK

Initialize the NomadicML client with your API key: 
from nomadicml import NomadicML

# Basic initialization
client = NomadicML(api_key="your_api_key")

# With custom configuration
client = NomadicML(
    api_key="your_api_key",
    base_url="https://api.nomadicml.company_name.com/",  # Custom endpoint for VPC setups
    timeout=900  # Request timeout in seconds
)

# Verify authentication
auth_info = client.verify_auth()
print("Authentication successful:", auth_info)

​
Configuration Parameters

ParameterTypeDefaultDescription
api_keystrNoneYour NomadicML API key (required)
base_urlstr"https://api-prod.nomadicml.com/"API endpoint URL
timeoutint900Request timeout in seconds

​
Verifying Authentication

Test your API key validity: SDK Method: 
auth_info = client.verify_auth()

​
Troubleshooting

Invalid API Key - If you receive an AuthenticationError:
  • Verify you’re using the correct API key
  • Check if the key has expired or been revoked
try:
    client = NomadicML(api_key="your_key")
    client.verify_auth()
except AuthenticationError as e:
    print(f"Authentication failed: {e}")
Connection Issues - If unable to connect:
  • Verify internet connectivity
  • Check for firewall restrictions on outgoing connections

​
Next Steps

SDK Examples

See practical examples of API usage with the SDK.

Quickstart Guide

Follow a step-by-step guide to using the API.