Client Initialization
Learn how to initialize and configure the ArmorIQ client
Client Initialization
ArmorIQClient
The main entry point for interacting with ArmorIQ.
from armoriq_sdk import ArmorIQClient
client = ArmorIQClient(
api_key: str = None,
user_id: str = None,
agent_id: str = None,
proxy_url: str = None,
timeout: int = 30,
max_retries: int = 3,
verify_ssl: bool = True
)Parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
| api_key | str | Yes | ARMORIQ_API_KEY env var | Your API key (format: ak_live_ + 64 hex characters) |
| user_id | str | Yes | ARMORIQ_USER_ID env var | User identifier for tracking |
| agent_id | str | Yes | ARMORIQ_AGENT_ID env var | Unique agent identifier |
| proxy_url | str | No | https://proxy.armoriq.io | ArmorIQ Proxy base URL |
| timeout | int | No | 30 | Request timeout in seconds |
| max_retries | int | No | 3 | Max retry attempts for failed requests |
| verify_ssl | bool | No | True | Verify SSL certificates |
Returns
ArmorIQClient instance
Raises
- ValueError: If required parameters are missing
- InvalidAPIKeyError: If API key format is invalid
Example
import os
from armoriq_sdk import ArmorIQClient
# Using environment variables (recommended)
client = ArmorIQClient()
# Explicit parameters
client = ArmorIQClient(
api_key="ak_live_" + "a" * 64,
user_id="user_12345",
agent_id="analytics_bot_v1",
proxy_url="https://proxy.armoriq.io",
timeout=60
)
# Custom configuration
client = ArmorIQClient(
api_key=os.getenv("ARMORIQ_API_KEY"),
user_id=get_current_user_id(),
agent_id=f"agent_{uuid.uuid4()}",
max_retries=5
)