Create Virtual Key

Azure OpenAI

Create virtual key to access your Azure OpenAI models or deployments, and manage all auth in one place.

Default Auth

Python

from portkey_ai import Portkey

client = Portkey(
    api_key="<api_key>"
)

virtual_key = client.virtual_keys.create(
    name="Azure-Virtual-Default",
    provider="azure-openai",
    note="Azure Note",
    key="<api_key>",
    resourceName="<resource_name>",
    deploymentConfig=[
        {
            "apiVersion": "2024-08-01-preview",
            "deploymentName": "DeploymentName",
            "is_default": True,
        },
        {
            "apiVersion": "2024-08-01-preview",
            "deploymentName": "DeploymentNam2e",
            "is_default": False,
        },
    ],
)

print(virtual_key)

import Portkey from 'portkey-ai';

const portkey = new Portkey({
  apiKey: 'PORTKEY_API_KEY'
});

async function main() {
  const key = await client.virtualKeys.create({
    name: "Azure-Virtual-Default",
    provider: "azure-openai",
    note: "Azure Note",
    key: "<api_key>",
    resourceName: "<resource_name>",
    deploymentConfig: [
        {
            "apiVersion": "2024-08-01-preview",
            "deploymentName": "DeploymentName",
            "is_default": True,
        },
        {
            "apiVersion": "2024-08-01-preview",
            "deploymentName": "DeploymentNam2e",
            "is_default": False,
        }
    ]
  });

  console.log(key);
}

main();

Azure Entra ID

Python

from portkey_ai import Portkey

client = Portkey(
    api_key="<api_key>"
)

virtual_key = client.virtual_keys.create(
    name="Azure-Virtual-entra",
    provider="azure-openai",
    note="azure entra",
    resourceName="<resource_name>",
    deploymentConfig=[
        {
            "deploymentName": "<deployment_name>",
            "is_default": True,
            "apiVersion": "2024-08-01-preview",
        }
    ],
    azureAuthMode="entra",
    azureEntraClientId="<client_id>",
    azureEntraClientSecret="<client_secret>",
    azureEntraTenantId="<tenantId>",
)

print(virtual_key)

import Portkey from 'portkey-ai';

const portkey = new Portkey({
  apiKey: 'PORTKEY_API_KEY'
});

async function main() {
  const key = await client.virtualKeys.create({
    name: "Azure-Virtual-entra",
    provider: "azure-openai",
    note: "azure entra",
    resourceName: "<resource_name>",
    deploymentConfig: [
        {
            "deploymentName": "<deployment_name>",
            "is_default": True,
            "apiVersion": "2024-08-01-preview",
        }
    ],
    azureAuthMode: "entra",
    azureEntraClientId: "<client_id>",
    azureEntraClientSecret: "<client_secret>",
    azureEntraTenantId: "<tenantId>"
  });

  console.log(key);
}

main();

Azure Managed Identity

Python

from portkey_ai import Portkey

client = Portkey(
    api_key="<api_key>",
)

virtual_key = client.virtual_keys.create(
    name="Azure-Virtual-entra",
    provider="azure-openai",
    note="azure entra",
    resourceName="<resource_name>",
    deploymentConfig=[
        {
            "deploymentName": "<deployment_name>",
            "is_default": True,
            "apiVersion": "2024-08-01-preview",
        }
    ],
    azureAuthMode="managed",
    azureManagedClientId="<client-id>" # optional
)

print(virtual_key)

import Portkey from 'portkey-ai';

const portkey = new Portkey({
  apiKey: 'PORTKEY_API_KEY'
});

async function main() {
  const key = await client.virtualKeys.create({
    name="Azure-Virtual-entra",
    provider="azure-openai",
    note="azure entra",
    resourceName="<resource_name>",
    deploymentConfig=[
        {
            "deploymentName": "<deployment_name>",
            "is_default": True,
            "apiVersion": "2024-08-01-preview",
        }
    ],
    azureAuthMode="managed",
    azureManagedClientId="<client-id>" # optional
  });

  console.log(key);
}

main();

AWS Bedrock

Create virtual key to access your AWS Bedrock models or deployments, and manage all auth in one place.

AWS Assumed Role

Python

from portkey_ai import Portkey

client = Portkey(
    api_key="<api_key>",
)

virtual_key = client.virtual_keys.create(
    name="bedrock-assumed",
    provider="bedrock",
    note="bedrock",
    awsRegion="<region>",
    awsAuthType="assumedRole",
    awsRoleArn="arn:aws:iam::<account_id>:role/<role_name>",
    awsExternalId="<external_id>",
)

print(virtual_key)

import Portkey from 'portkey-ai';

const portkey = new Portkey({
  apiKey: 'PORTKEY_API_KEY'
});

async function main() {
  const key = await client.virtualKeys.create({
    name: "bedrock-assumed",
    provider: "bedrock",
    note: "bedrock",
    awsRegion: "<region>",
    awsAuthType: "assumedRole",
    awsRoleArn: "arn:aws:iam::<account_id>:role/<role_name>",
    awsExternalId: "<external_id>"
  });

  console.log(key);
}

main();

Vertex AI

Create virtual key to access any models available or hosted on Vertex AI. Docs →

Learn More About Virtual Keys

Securely store your provider auth in Portkey vault and democratize and streamline access to Gen AI.