API Key Management

Secure, scalable API key management for programmatic access to AIM. Perfect for SDKs, CI/CD pipelines, and automated agent operations.

SHA-256
Hashed Storage
5K/min
Rate Limit
90 Days
Auto Rotation
Encrypted
At Rest & Transit

What are API Keys?

API keys are long-lived credentials for programmatic access to AIM. They're perfect for:

SDK Integration

Python, Node.js, Go SDKs authenticate using API keys for agent operations

CI/CD Pipelines

Automated deployments and agent registration in build pipelines

Server-to-Server

Backend services communicating with AIM without user interaction

Automation Scripts

Batch operations, monitoring scripts, and automated workflows

API Key Format

AIM API keys follow a structured format for easy identification:

ak_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
ak_API Key prefix
live_Environment (live/test)
xxx...Random identifier

Quick Start: Using API Keys

1. Create API Key

Dashboard → API Keys → Create API Key → Copy key

2. Verify a Capability (Core Use Case)

# The most common API call - verify if an agent can perform an action
curl -X POST "https://aim.example.com/api/v1/agents/AGENT-ID/verify-capability" \
  -H "Authorization: Bearer YOUR-API-KEY" \
  -H "Content-Type: application/json" \
  -d '{"capability": "api:call", "resource": "weather.api"}'

# Response
{
  "allowed": true,
  "auditId": "audit-uuid-here",
  "trustScore": 0.90
}

3. Other Common Requests

# List agents
curl -H "Authorization: Bearer $AIM_API_KEY" \
  https://aim.example.com/api/v1/agents

# Get agent details
curl -H "Authorization: Bearer $AIM_API_KEY" \
  https://aim.example.com/api/v1/agents/AGENT-ID
Pro tip: Both Authorization: Bearer API-KEY and X-API-Key: API-KEY headers work.

🚀 Next Steps

Ready to start using API keys in your application?