Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.portkey.ai/docs/llms.txt

Use this file to discover all available pages before exploring further.

​
API Keys

Portkey uses two types of API keys to manage access to resources and operations: Admin API Keys and Workspace API Keys. These keys play crucial roles in authenticating and authorizing various operations within your organization and workspaces.

​
Admin API Keys

Admin API Keys operate at the organization level and provide broad access across all workspaces within an organization. Key features of Admin API Keys:
  • Created and managed by organization owners and admins
  • Provide access to organization-wide operations
  • Can perform actions across all workspaces in the organization
  • Used for administrative tasks and integrations that require broad access
  • When making updates to entities, can specify a workspace_id to target specific workspaces
Admin API Keys should be carefully managed and their use should be limited to necessary administrative operations due to their broad scope of access.

​
Admin API Key Permission Scopes

ScopeDescription
organisation_users.createCreate new users in the organization
organisation_users.readView organization user details
organisation_users.updateModify organization user settings
organisation_users.deleteRemove users from the organization
organisation_users.listList all organization users
organisation_service_api_keys.createCreate new organization service API keys
organisation_service_api_keys.updateModify organization service API keys
organisation_service_api_keys.readView organization service API key details
organisation_service_api_keys.deleteDelete organization service API keys
organisation_service_api_keys.listList all organization service API keys
organisation_service_api_keys.rotateRegenerate organization service API keys
audit_logs.listAccess system-wide audit logs
plugins.createCreate plugins
plugins.updateUpdate plugins
plugins.listList plugins
deployments.createCreate new deployments
deployments.readView deployment details
deployments.updateModify deployment settings
deployments.deleteRemove deployments
deployments.listList deployments
secret_references.createCreate new secret references
secret_references.readView secret reference details
secret_references.updateModify secret references
secret_references.deleteDelete secret references
secret_references.listList secret references
ScopeDescription
workspaces.createCreate new workspaces
workspaces.readView workspace details
workspaces.updateModify workspace settings
workspaces.deleteDelete workspaces
workspaces.listList all workspaces
workspace_service_api_keys.createCreate new workspace service API keys
workspace_service_api_keys.updateModify workspace service API keys
workspace_service_api_keys.readView workspace service API key details
workspace_service_api_keys.deleteDelete workspace service API keys
workspace_service_api_keys.listList all workspace service API keys
workspace_service_api_keys.rotateRegenerate workspace service API keys
workspace_user_api_keys.createCreate new workspace user API keys
workspace_user_api_keys.updateModify workspace user API keys
workspace_user_api_keys.readView workspace user API key details
workspace_user_api_keys.deleteDelete workspace user API keys
workspace_user_api_keys.listList all workspace user API keys
workspace_user_api_keys.rotateRegenerate workspace user API keys
workspace_users.createCreate new workspace users
workspace_users.readView workspace user details
workspace_users.updateUpdate workspace user settings
workspace_users.deleteRemove users from workspace
workspace_users.listList workspace users
ScopeDescription
prompts.createCreate new prompt templates
prompts.readView prompt template details
prompts.updateModify existing prompt templates
prompts.deleteDelete prompt templates
prompts.listList available prompt templates
prompts.publishPublish prompt templates
configs.createCreate new configurations
configs.updateUpdate existing configurations
configs.deleteDelete configurations
configs.readView configuration details
configs.listList available configurations
guardrails.createCreate new guardrails
guardrails.readView guardrail details
guardrails.updateModify existing guardrails
guardrails.deleteDelete guardrails
guardrails.listList available guardrails
virtual_keys.createCreate new virtual keys
virtual_keys.readView virtual key details
virtual_keys.updateModify existing virtual keys
virtual_keys.deleteDelete virtual keys
virtual_keys.listList available virtual keys
virtual_keys.duplicateDuplicate virtual keys
virtual_keys.copyCopy virtual keys
providers.createCreate new providers
providers.readView provider details
providers.updateUpdate existing providers
providers.deleteDelete providers
providers.listList available providers
policies.createCreate policies
policies.readView policy details
policies.updateUpdate policies
policies.deleteDelete policies
policies.listList policies
ScopeDescription
organisation_integrations.createCreate organisation-level integrations
organisation_integrations.readView organisation integration details
organisation_integrations.updateUpdate organisation integrations
organisation_integrations.deleteDelete organisation integrations
organisation_integrations.listList organisation integrations
organisation_mcp_integrations.createCreate organisation MCP integrations
organisation_mcp_integrations.readView organisation MCP integration details
organisation_mcp_integrations.updateUpdate organisation MCP integrations
organisation_mcp_integrations.deleteDelete organisation MCP integrations
organisation_mcp_integrations.listList organisation MCP integrations
organisation_agent_integrations.createCreate organisation agent integrations
organisation_agent_integrations.readView organisation agent integration details
organisation_agent_integrations.updateUpdate organisation agent integrations
organisation_agent_integrations.deleteDelete organisation agent integrations
organisation_agent_integrations.listList organisation agent integrations
workspace_integrations.createCreate workspace integrations
workspace_integrations.readView workspace integration details
workspace_integrations.updateUpdate workspace integrations
workspace_integrations.deleteDelete workspace integrations
workspace_integrations.listList workspace integrations
workspace_mcp_integrations.createCreate workspace MCP integrations
workspace_mcp_integrations.readView workspace MCP integration details
workspace_mcp_integrations.updateUpdate workspace MCP integrations
workspace_mcp_integrations.deleteDelete workspace MCP integrations
workspace_mcp_integrations.listList workspace MCP integrations
workspace_agent_integrations.createCreate workspace agent integrations
workspace_agent_integrations.readView workspace agent integration details
workspace_agent_integrations.updateUpdate workspace agent integrations
workspace_agent_integrations.deleteDelete workspace agent integrations
workspace_agent_integrations.listList workspace agent integrations
ScopeDescription
agent_servers.createCreate agent servers
agent_servers.readView agent server details
agent_servers.updateUpdate agent servers
agent_servers.deleteDelete agent servers
agent_servers.listList agent servers
mcp_servers.createCreate MCP servers
mcp_servers.readView MCP server details
mcp_servers.updateUpdate MCP servers
mcp_servers.deleteDelete MCP servers
mcp_servers.listList MCP servers
ScopeDescription
analytics.viewAccess analytics data
logs.exportExport logs to external systems
logs.listList available logs
logs.viewView log details

​
Workspace API Keys

Workspace API Keys are scoped to a specific workspace and are used for operations within that workspace only. There are two types — Service API Keys and User API Keys — which share most scopes. The only difference is that Service API Keys can also manage other API keys within the workspace; User API Keys cannot.

​
Workspace Service API Keys

Used for automated processes, backend integrations, and CI pipelines. In addition to all operational scopes, service keys can create, update, rotate, and delete other workspace API keys.
ScopeDescription
workspace_service_api_keys.createCreate new workspace service API keys
workspace_service_api_keys.readView workspace service API key details
workspace_service_api_keys.updateModify workspace service API keys
workspace_service_api_keys.deleteDelete workspace service API keys
workspace_service_api_keys.listList all workspace service API keys
workspace_service_api_keys.rotateRegenerate workspace service API keys
workspace_user_api_keys.createCreate new workspace user API keys
workspace_user_api_keys.readView workspace user API key details
workspace_user_api_keys.updateModify workspace user API keys
workspace_user_api_keys.deleteDelete workspace user API keys
workspace_user_api_keys.listList all workspace user API keys
workspace_user_api_keys.rotateRegenerate workspace user API keys
ScopeDescription
workspaces.readView workspace details
workspaces.updateModify workspace settings
workspaces.listList available workspaces
workspace_users.createCreate new workspace users
workspace_users.readView workspace user details
workspace_users.updateUpdate workspace user settings
workspace_users.deleteRemove users from workspace
workspace_users.listList workspace users
ScopeDescription
completions.writeCreate and manage completions (includes /chat/completions, /completions, /images, /audio)
prompts.createCreate new prompt templates
prompts.readView prompt template details
prompts.updateModify existing prompt templates
prompts.deleteDelete prompt templates
prompts.listList available prompt templates
prompts.publishPublish prompt templates
prompts.renderRender prompt templates
ScopeDescription
mcp.invokeCall MCP gateway methods
mcp_servers.createCreate MCP servers
mcp_servers.readView MCP server details
mcp_servers.updateUpdate MCP servers
mcp_servers.deleteDelete MCP servers
mcp_servers.listList MCP servers
workspace_mcp_integrations.createCreate workspace MCP integrations
workspace_mcp_integrations.readView workspace MCP integration details
workspace_mcp_integrations.updateUpdate workspace MCP integrations
workspace_mcp_integrations.deleteDelete workspace MCP integrations
workspace_mcp_integrations.listList workspace MCP integrations
organisation_mcp_integrations.listList organisation MCP integrations
ScopeDescription
agents.invokeInvoke agents
agent_servers.createCreate agent servers
agent_servers.readView agent server details
agent_servers.updateUpdate agent servers
agent_servers.deleteDelete agent servers
agent_servers.listList agent servers
workspace_agent_integrations.createCreate workspace agent integrations
workspace_agent_integrations.readView workspace agent integration details
workspace_agent_integrations.updateUpdate workspace agent integrations
workspace_agent_integrations.deleteDelete workspace agent integrations
workspace_agent_integrations.listList workspace agent integrations
organisation_agent_integrations.listList organisation agent integrations
ScopeDescription
configs.createCreate new configurations
configs.updateUpdate existing configurations
configs.deleteDelete configurations
configs.readView configuration details
configs.listList available configurations
guardrails.createCreate new guardrails
guardrails.readView guardrail details
guardrails.updateModify existing guardrails
guardrails.deleteDelete guardrails
guardrails.listList available guardrails
guardrails.invokeInvoke guardrails directly
virtual_keys.createCreate new virtual keys
virtual_keys.readView virtual key details
virtual_keys.updateModify existing virtual keys
virtual_keys.deleteDelete virtual keys
virtual_keys.listList available virtual keys
virtual_keys.duplicateDuplicate virtual keys
virtual_keys.copyCopy virtual keys
providers.createCreate new providers
providers.readView provider details
providers.updateUpdate existing providers
providers.deleteDelete providers
providers.listList available providers
policies.createCreate policies
policies.readView policy details
policies.updateUpdate policies
policies.deleteDelete policies
policies.listList policies
ScopeDescription
workspace_integrations.createCreate workspace integrations
workspace_integrations.readView workspace integration details
workspace_integrations.updateUpdate workspace integrations
workspace_integrations.deleteDelete workspace integrations
workspace_integrations.listList workspace integrations
organisation_integrations.listList organisation integrations
ScopeDescription
analytics.viewAccess analytics data
logs.exportExport logs to external systems
logs.listList available logs
logs.viewView log details
logs.writeCreate and modify logs

​
Workspace User API Keys

Associated with individual users within a workspace. Identical in scope to service keys except they cannot manage other API keys — use these for personal access and user-level integrations.
ScopeDescription
workspaces.readView workspace details
workspaces.updateModify workspace settings
workspaces.listList available workspaces
workspace_users.createCreate new workspace users
workspace_users.readView workspace user details
workspace_users.updateUpdate workspace user settings
workspace_users.deleteRemove users from workspace
workspace_users.listList workspace users
ScopeDescription
completions.writeCreate and manage completions (includes /chat/completions, /completions, /images, /audio)
prompts.createCreate new prompt templates
prompts.readView prompt template details
prompts.updateModify existing prompt templates
prompts.deleteDelete prompt templates
prompts.listList available prompt templates
prompts.publishPublish prompt templates
prompts.renderRender prompt templates
ScopeDescription
mcp.invokeCall MCP gateway methods
mcp_servers.createCreate MCP servers
mcp_servers.readView MCP server details
mcp_servers.updateUpdate MCP servers
mcp_servers.deleteDelete MCP servers
mcp_servers.listList MCP servers
workspace_mcp_integrations.createCreate workspace MCP integrations
workspace_mcp_integrations.readView workspace MCP integration details
workspace_mcp_integrations.updateUpdate workspace MCP integrations
workspace_mcp_integrations.deleteDelete workspace MCP integrations
workspace_mcp_integrations.listList workspace MCP integrations
organisation_mcp_integrations.listList organisation MCP integrations
ScopeDescription
agents.invokeInvoke agents
agent_servers.createCreate agent servers
agent_servers.readView agent server details
agent_servers.updateUpdate agent servers
agent_servers.deleteDelete agent servers
agent_servers.listList agent servers
workspace_agent_integrations.createCreate workspace agent integrations
workspace_agent_integrations.readView workspace agent integration details
workspace_agent_integrations.updateUpdate workspace agent integrations
workspace_agent_integrations.deleteDelete workspace agent integrations
workspace_agent_integrations.listList workspace agent integrations
organisation_agent_integrations.listList organisation agent integrations
ScopeDescription
configs.createCreate new configurations
configs.updateUpdate existing configurations
configs.deleteDelete configurations
configs.readView configuration details
configs.listList available configurations
guardrails.createCreate new guardrails
guardrails.readView guardrail details
guardrails.updateModify existing guardrails
guardrails.deleteDelete guardrails
guardrails.listList available guardrails
guardrails.invokeInvoke guardrails directly
virtual_keys.createCreate new virtual keys
virtual_keys.readView virtual key details
virtual_keys.updateModify existing virtual keys
virtual_keys.deleteDelete virtual keys
virtual_keys.listList available virtual keys
virtual_keys.duplicateDuplicate virtual keys
virtual_keys.copyCopy virtual keys
providers.createCreate new providers
providers.readView provider details
providers.updateUpdate existing providers
providers.deleteDelete providers
providers.listList available providers
policies.createCreate policies
policies.readView policy details
policies.updateUpdate policies
policies.deleteDelete policies
policies.listList policies
ScopeDescription
workspace_integrations.createCreate workspace integrations
workspace_integrations.readView workspace integration details
workspace_integrations.updateUpdate workspace integrations
workspace_integrations.deleteDelete workspace integrations
workspace_integrations.listList workspace integrations
organisation_integrations.listList organisation integrations
ScopeDescription
analytics.viewAccess analytics data
logs.exportExport logs to external systems
logs.listList available logs
logs.viewView log details
logs.writeCreate and modify logs

​
Using API Key Scopes

When creating or updating API keys, you can define specific permission scopes based on your security requirements: Both types of API keys play important roles in Portkey’s security model, enabling secure and efficient access to resources while maintaining proper separation of concerns between organization-wide administration and workspace-specific operations.

Organizations

Workspaces

User Roles & Permissions

Last modified on May 26, 2026