Scoped API Keys
How to create and manage scoped API keys for specific agents and environments.
Scoped API keys let you grant narrow access to specific agents, with quotas and optional environment restrictions. They are useful when you want a customer, team, or internal system to call only a subset of your agents.
1. Open the Pro dashboard
In AgentOven Pro, scoped keys are managed from the Scoped API Keys page in the dashboard. The list shows:
- Key prefix
- Allowed agents
- Allowed environments
- Call count / quota
- Revocation state
- Expiry
2. Create a scoped key
Choose the agents and environments it can access, then set a quota if needed.
Example settings:
- Name:
frontend-demo - Agents:
research-bot,summarizer - Environments:
dev,staging - Max calls:
1000 - Expiry:
7d
3. Use the API
The Pro dashboard API exposes scoped keys under /api/v1/keys.
bash
# List keys curl -H "Authorization: Bearer <token>" \ -H "X-Kitchen: demo-kitchen" \ http://localhost:8080/api/v1/keys # Create a key curl -X POST \ -H "Content-Type: application/json" \ -H "Authorization: Bearer <token>" \ -H "X-Kitchen: demo-kitchen" \ -d '{ "label": "frontend-demo", "agent_names": ["research-bot"], "environment_names": ["dev", "staging"], "max_calls": 1000, "expires_in": "7d" }' \ http://localhost:8080/api/v1/keys
The response returns the secret key once. Store it securely, then distribute it only to the caller that needs it.
4. Revoke or delete access
Revocation disables the key immediately without changing the agents themselves.
bash
# Revoke curl -X POST \ -H "Authorization: Bearer <token>" \ -H "X-Kitchen: demo-kitchen" \ http://localhost:8080/api/v1/keys/<id>/revoke # Delete curl -X DELETE \ -H "Authorization: Bearer <token>" \ -H "X-Kitchen: demo-kitchen" \ http://localhost:8080/api/v1/keys/<id>
5. Good defaults
- Keep keys agent-specific whenever possible.
- Prefer environment allowlists over
*. - Use short expirations for demos and partner access.
- Revoke keys instead of reusing old secrets.