> ## Documentation Index
> Fetch the complete documentation index at: https://portkey-docs-add-third-party-integration-issues-fixes.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.
# Introduction
> Manage your Portkey organization and workspaces programmatically
# Portkey Admin API
The Portkey Admin API provides programmatic access to manage your organization, workspaces, and resources. Whether you're automating routine administration tasks, integrating Portkey with your existing systems, or customizing your deployment at scale, this API gives you the tools to control every aspect of your Portkey implementation.
## Understanding the Admin API Ecosystem
The Admin API is organized around key capabilities that let you manage different aspects of your Portkey environment. Let's explore what you can build and automate:
### Resource Management
At the foundation of Portkey are the resources that define how your AI implementation works. These can all be managed programmatically:
Create and manage configuration profiles that define routing rules, model settings, and more.
Manage AI providers and credentials across workspaces. Replaces Virtual Keys.
Create and manage API keys for accessing Portkey services.
### Analytics and Monitoring
Once your resources are configured, you'll want to measure performance and usage. The Admin API gives you powerful tools to access analytics data:
Retrieve aggregated usage statistics and performance metrics.
Access detailed analytics organized by metadata, model, or user.
Monitor performance trends, costs, errors, feedback, and usage patterns over time.
### User and Workspace Administration
Beyond resources and analytics, you'll need to manage who has access to your Portkey environment:
Manage user accounts, permissions, and access. Send and manage user invitations.
Create workspaces and manage team membership and permissions within workspaces.
## Authentication Strategy
Now that you understand what the Admin API can do, let's explore how to authenticate your requests. Portkey uses a sophisticated access control system with two types of API keys, each designed for different use cases:
**Organization-wide access**
These keys grant access to administrative operations across your entire organization.
Only Organization Owners and Admins can create and manage Admin API keys.
**Workspace-specific access**
These keys provide targeted access to resources within a single workspace.
Workspace Managers can create and manage Workspace API keys.
The key you use determines which operations you can perform. For organization-wide administrative tasks, you'll need an Admin API key. For workspace-specific operations, you can use a Workspace API key.
## Access Control and Permissions Model
Portkey's hierarchical access control system governs who can use which APIs. Let's examine how roles, API keys, and permissions interact:
```mermaid theme={null}
graph TD
A[Organization] --> B[Owner]
A --> C[Org Admin]
A --> D[Workspaces]
B --> E[Admin API Key]
C --> E
D --> F[Workspace Manager]
D --> G[Workspace Member]
F --> H[Workspace API Key]
E --> I[Organization-wide Operations]
H --> J[Workspace-specific Operations]
classDef entity fill:#4a5568,stroke:#ffffff,color:#ffffff
classDef roles fill:#805ad5,stroke:#ffffff,color:#ffffff
classDef keys fill:#3182ce,stroke:#ffffff,color:#ffffff
classDef operations fill:#38a169,stroke:#ffffff,color:#ffffff
class A,D entity
class B,C,F,G roles
class E,H keys
class I,J operations
```
This access model follows a clear hierarchy:
| Role | Can Create Admin API Key | Can Create Workspace API Key | Access Scope |
| :----------------- | :----------------------- | :--------------------------- | :------------------------- |
| Organization Owner | ✅ | ✅ (any workspace) | All organization resources |
| Organization Admin | ✅ | ✅ (any workspace) | All organization resources |
| Workspace Manager | ❌ | ✅ (managed workspace only) | Single workspace resources |
| Workspace Member | ❌ | ❌ | Limited workspace access |
## Creating and Managing API Keys
Now that you understand the permission model, let's look at how to create the API keys you'll need:
### Through the Portkey Dashboard
The simplest way to create an API key is through the Portkey dashboard:
### Through the API
You can also create keys programmatically:
```sh Creating Admin API Key {1,2} theme={null}
curl -X POST https://api.portkey.ai/v1/api-keys/organisation/service
-H "x-portkey-api-key: YOUR_EXISTING_ADMIN_KEY" \
-H "Content-Type: application/json" \
-d '{
"name":"API_KEY_NAME_0809",
"scopes":[
"logs.export",
"logs.list",
"logs.view"
]
}'
```
```sh Creating Workspace API Key {1,2} theme={null}
curl -X POST https://api.portkey.ai/v1/api-keys/workspace/user \
-H "x-portkey-api-key: YOUR_EXISTING_WORKSPACE_KEY" \
-H "Content-Type: application/json" \
-d '{
"name":"API_KEY_NAME_0909",
"workspace_id":"WORKSPACE_ID",
"scopes":[
"virtual_keys.create",
"virtual_keys.update",
]
}'
```
## Understanding API Key Capabilities
Both key types have different capabilities. This table clarifies which operations each key type can perform:
| Operation | Admin API Key | Workspace API Key |
| :--------------------------- | :----------------- | :------------------- |
| Manage organization settings | ✅ | ❌ |
| Create/manage workspaces | ✅ | ❌ |
| Manage users and permissions | ✅ | ❌ |
| Create/manage configs | ✅ (All workspaces) | ✅ (Single workspace) |
| Create/manage providers | ✅ (All workspaces) | ✅ (Single workspace) |
| Access Analytics | ✅ (All workspaces) | ✅ (Single workspace) |
| Create/update feedback | ❌ | ✅ |
## Security and Compliance: Audit Logs
For security-conscious organizations, Portkey provides comprehensive audit logging of all Admin API operations. These logs give you complete visibility into administrative actions:
Every administrative action is recorded with:
* User identity
* Action type and target resource
* Timestamp
* IP address
* Request details
This audit trail helps maintain compliance and provides accountability for all administrative changes.
Learn more about Portkey's audit logging capabilities
## Getting Started with the Admin API
Now that you understand the Admin API ecosystem, authentication, and permissions model, you're ready to start making requests. Here's what you'll need:
1. **Appropriate role**: Ensure you have the right permissions (Org Owner/Admin for Admin API, Workspace Manager for Workspace API)
2. **API key**: Generate the appropriate key from the Portkey dashboard
3. **Make your first request**: Use your key in the request header
For developers looking to integrate with the Admin API, we provide a complete OpenAPI specification that you can use with your API development tools:
Download the OpenAPI spec for the Admin API
## Need Support?
If you need help setting up or using the Admin API, our team is ready to assist:
Schedule time with our team to get personalized help with the Admin API