Admin API
The Admin API allows you to programmatically manage your organization’s resources, including organization members, workspaces, and API keys. This provides programmatic control over administrative tasks that would otherwise require manual configuration in the Anthropic Console.
The Admin API requires special access
The Admin API requires a special Admin API key (starting with sk-ant-admin...) that differs from standard API keys. Only organization members with the admin role can provision Admin API keys through the Anthropic Console.
How the Admin API works
When you use the Admin API:
- You make requests using your Admin API key in the
x-api-keyheader - The API allows you to manage:
- Organization members and their roles
- Organization member invites
- Workspaces and their members
- API keys
This is useful for:
- Automating user onboarding/offboarding
- Programmatically managing workspace access
- Monitoring and managing API key usage
Organization roles and permissions
There are four organization-level roles.
| Role | Permissions |
|---|---|
| user | Can use Workbench |
| developer | Can use Workbench and manage API keys |
| billing | Can use Workbench and manage billing details |
| admin | Can do all of the above, plus manage users |
Key concepts
Organization Members
You can list organization members, update member roles, and remove members.
Organization Invites
You can invite users to organizations and manage those invites.
Workspaces
Create and manage workspaces to organize your resources:
Workspace Members
Manage user access to specific workspaces:
API Keys
Monitor and manage API keys:
Best practices
To effectively use the Admin API:
- Use meaningful names and descriptions for workspaces and API keys
- Implement proper error handling for failed operations
- Regularly audit member roles and permissions
- Clean up unused workspaces and expired invites
- Monitor API key usage and rotate keys periodically
FAQ
Was this page helpful?