API key management

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

SHA-256

Hashed storage

5K/min

Rate limit

90 days

Auto rotation

Encrypted

At rest and in transit

What are API keys?

API keys are long-lived credentials for programmatic access to AIM. They suit:

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 an API key

Dashboard, then API keys, then create API key, then 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?

API reference →Python SDK →Security guide →