POST
/
virtual-keys

Azure OpenAI

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

AWS Bedrock

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

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.

Authorizations

x-portkey-api-key
string
header
required

Body

application/json
name
string
provider
enum<string>
Available options:
openai,
azure-openai,
ai21,
anthropic,
anyscale,
azure-openai,
bedrock,
cohere,
deepinfra,
fireworks-ai,
google,
groq,
hugging-face,
jina,
lingyi,
mistral-ai,
monsterapi,
moonshot,
nomic,
novita-ai,
open-ai,
openrouter,
palm,
perplexity-ai,
predibase,
reka-ai,
segmind,
stability-ai,
together-ai,
vertex-ai,
workers-ai,
zhipu
key
string
note
string | null
apiVersion
string | null
resourceName
string | null
deploymentName
string | null
workspace_id
string

optional, needed when using organisation admin API keys

deploymentConfig
object[]
usage_limits
object
rate_limits
object

Response

200
application/json
Successful response
success
boolean
data
object