Getting Started in 5 Minutes

Where's Your License Key?

After purchase, you'll receive a welcome email with your license key.

It looks like: as_pro_xxxxxxxxxxxxxxxx

You can also find it in your Account Portal. Sign in with your email to view, copy, or reveal your full license key.

1. Activate Your License

Your license key was sent to your email. It looks like:

as_pro_xxxxxxxxxxxxxxxx

Set it as an environment variable:

# Linux/Mac
export AGENTSENTINEL_LICENSE_KEY="as_pro_your_key_here"

# Windows (PowerShell)
$env:AGENTSENTINEL_LICENSE_KEY="as_pro_your_key_here"

# Or add to your .env file
AGENTSENTINEL_LICENSE_KEY=as_pro_your_key_here

2. Install the SDK

# Python
pip install agentsentinel-core

# Node.js / TypeScript
npm install @agentsentinel/sdk

3. Your First Protected Agent (5-Minute Tutorial)

Python

from agentsentinel import AgentPolicy, AgentGuard

# Define your safety policy
policy = AgentPolicy(
    daily_budget=10.00,          # Stop at $10/day
    hourly_budget=2.00,          # Stop at $2/hour
    require_approval=["send_email", "delete_*"],
    rate_limits={"web_search": "10/min"},
    audit_log=True,
)

# Create a guard
guard = AgentGuard(policy=policy)

# Protect any function
@guard.protect(tool_name="web_search", cost=0.01)
def web_search(query: str) -> str:
    # Your actual search implementation
    return f"Results for: {query}"

# Use it normally - AgentSentinel handles the rest!
result = web_search("AI safety best practices")
print(result)

TypeScript

import { AgentPolicy, AgentGuard } from '@agentsentinel/sdk';

const policy = new AgentPolicy({
    dailyBudget: 10.00,
    hourlyBudget: 2.00,
    requireApproval: ['send_email', 'delete_*'],
    rateLimits: { 'web_search': '10/min' },
    auditLog: true,
});

const guard = new AgentGuard({ policy });

const webSearch = guard.protect(
    async (query: string) => {
        return `Results for: ${query}`;
    },
    { toolName: 'web_search', cost: 0.01 }
);

// Use it normally
const result = await webSearch("AI safety best practices");

4. Launch the Dashboard

# Python
python -m agentsentinel.dashboard

# Then open http://localhost:8050 in your browser

• Real-time cost tracking
• Audit log of all tool calls
• Budget usage meters
• Approval queue (if using approval gates)

4a. Entering Your License in the Dashboard

You can activate your license directly in the dashboard UI to unlock all features and see your plan limits.

1. Start the dashboard: python -m agentsentinel.dashboard
2. Open http://localhost:8050 in your browser
3. Click the ⚙️ Settings icon in the top-right corner
4. Go to the License tab
5. Paste your license key and click Activate
6. ✓ Done! Your tier, limits, and usage will display immediately.

5. What's Included in Your Plan

6. Next Steps

• 📖 Full Documentation
• 🔒 Security Best Practices
• 💬 Get Support
• 🐙 GitHub Repository

7. Common Issues