Quick Start
Get up and running with AIM in under 5 minutes. This guide will walk you through setting up your first AI agent and verifying its identity.
Prerequisites: Node.js 18+ or Python 3.8+ installed on your system.
Step 1: Download Your Personalized SDK
Zero Configuration: We don't distribute via pip/npm. Instead, download your personalized SDK from the dashboard - it comes pre-configured with your credentials!
Download Process
- 1. Deploy AIM and login to your dashboard at
http://localhost:3000 - 2. Navigate to Settings → SDK Download
- 3. Click "Download Python SDK"
- 4. Extract the downloaded SDK package
- 5. Start using immediately - no configuration needed!
Step 2: No API Keys Needed!
SDK Users: Your downloaded SDK already has credentials embedded - skip to Step 3!
Only for Direct API Integration (if you're not using the SDK):
- Go to your AIM dashboard at
http://localhost:3000 - Navigate to Settings → API Keys
- Click Generate New Key
- Copy your API key for direct API calls
Step 3: Use Your SDK
Python SDK (Pre-Configured)
# Navigate to your extracted SDK folder
# No installation needed - just import and use!
from aim_sdk import secure
# One line - your agent is registered!
agent = secure("my-agent")
# That's it! No API keys, no URLs, no configuration!
# The SDK already knows your credentialsDirect API Usage (Without SDK)
import requests
# Only needed if you're NOT using the SDK
headers = {
"Authorization": f"Bearer {api_key}",
"X-Organization-ID": organization_id
}
response = requests.post(
"https://api.opena2a.org/v1/agents/register",
headers=headers,
json={"name": "my-agent", "type": "ai_agent"}
)Step 4: Secure Your Actions
Python - Automatic Action Verification
# Your agent was already registered in Step 3!
# Now just use decorators for automatic verification
@agent.perform_action("read_database", resource="users_table")
def get_user_data(user_id):
"""This action is automatically verified by AIM"""
return database.query(f"SELECT * FROM users WHERE id = {user_id}")
@agent.perform_action("send_email", resource="admin@example.com")
def send_notification(message):
"""High-risk actions require higher trust scores"""
send_email("admin@example.com", message)
# Call your functions normally - AIM handles verification
data = get_user_data(12345)
send_notification("System update complete")Step 5: Verify Agent Identity
JavaScript/TypeScript
// Create a signature
import { signPayload } from '@opena2a/aim-sdk';
const payload = {
action: 'generate_text',
timestamp: Date.now(),
nonce: crypto.randomBytes(16).toString('hex')
};
const signature = await signPayload(payload, privateKey);
// Verify the agent
const verification = await client.agents.verify(
agent.id,
signature,
payload
);
if (verification.valid) {
console.log('✅ Agent identity verified');
console.log('Trust score:', verification.trustScore);
} else {
console.log('❌ Verification failed');
}