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.
Your AI Gateway. Your Infrastructure. 2 Hours. Deploy Portkeyβs data plane in your VPC and start routing LLM traffic securely. No data leaves your network. 247 Teams deployed
2.3 hrs Average time
15 min To first API call
π― What Youβll Have in 2 Hours
Working AI Gateway Route requests to OpenAI, Anthropic, and 1600+ LLMs through your private endpoint
Complete Data Privacy All prompts and responses stay in your VPC. Only metrics leave (no sensitive data).
Full Observability See every request, cost, latency, and error in the Portkey dashboard
π Your 4-Step Journey
Check Prerequisites
Verify your Kubernetes cluster and create storage buckets
Get Credentials
Receive and test your access tokens from Portkey
Deploy Gateway
Run one Helm command with our production-ready template
Validate Success
Make your first API call and see logs flowing
Step 1: Check Prerequisites (5 min)
β Quick Checks # 1. Kubernetes ready?
kubectl version --short
# Need: v1.24+
# 2. Helm installed?
helm version --short
# Need: v3.0+
# 3. Can reach internet?
curl -I https://control.portkey.ai
# Need: HTTP/2 200
β Pick Your Storage AWS (S3)
GCS
Quick Test (Wasabi)
# Create a bucket
aws s3 mb s3://my-portkey-logs
# Create a bucket
gsutil mb gs://my-portkey-logs
Weβll provide temporary credentials - no setup needed!
Need help? Start a quick chat Most issues resolved in under 10 minutes
Step 2: Get Credentials (10 min)
Youβll receive a 1Password link with two items:
π³ Docker Access Username & password for our container registry
π Gateway Token JWT to connect your gateway to control plane
Quick Test
# 1. Test Docker access
docker login -u < usernam e > -p < passwor d >
docker pull portkey/gateway-enterprise:latest
# 2. Create Kubernetes secret
kubectl create namespace portkey
kubectl -n portkey create secret docker-registry portkey-creds \
--docker-username= < username > \
--docker-password= < password >
Step 3: Deploy Gateway (30 min)
3.1 Save This Config
Create values.yaml with your details: # values.yaml - Production-ready config
replicaCount : 2
images :
gatewayImage :
repository : "portkey/gateway-enterprise"
tag : "1.10.24"
environment :
data :
# Your identifiers
SERVICE_NAME : "my-company-gateway"
PORTKEY_CLIENT_AUTH : "<token-from-1password>"
# Storage (pick one)
LOG_STORE : "s3" # or "gcs", "mongo", "wasabi"
LOG_STORE_REGION : "us-east-1"
LOG_STORE_GENERATIONS_BUCKET : "my-portkey-logs"
LOG_STORE_ACCESS_KEY : "<your-access-key>"
LOG_STORE_SECRET_KEY : "<your-secret-key>"
# Cache (auto-deployed)
CACHE_STORE : "redis"
REDIS_URL : "redis://portkey-redis:6379"
# Analytics
ANALYTICS_STORE : "control_plane"
# Expose your gateway
ingress :
enabled : true
className : "nginx"
hosts :
- host : gateway.internal.mycompany.com
paths :
- path : /
pathType : Prefix
# Auto-scaling
autoscaling :
enabled : true
minReplicas : 2
maxReplicas : 10
3.2 Deploy with One Command
# Add Portkey charts
helm repo add portkey https://portkey-ai.github.io/helm
helm repo update
# Deploy!
helm upgrade --install portkey-gateway portkey/gateway \
-n portkey -f values.yaml
# Watch it come up
kubectl -n portkey get pods -w
Expected output: NAME READY STATUS
portkey-gateway-7f9b8c5d4-abc123 1/1 Running
portkey-gateway-7f9b8c5d4-def456 1/1 Running
portkey-redis-master-0 1/1 Running
Step 4: Validate Success (15 min)
4.1 Check Health
# Port-forward for quick test
kubectl -n portkey port-forward svc/portkey-gateway 8787:8787
# In new terminal
curl http://localhost:8787/v1/health
# β
Should return: {"status":"healthy"}
4.2 Get Your API Keys
Go to app.portkey.ai/model-catalog
Click βAdd Providerβ
Select your LLM provider (e.g., OpenAI)
Enter your OpenAI API key
Name your provider (e.g., openai-prod)
4.3 Make Your First Call! π
# Using your gateway URL
curl https://gateway.internal.mycompany.com/v1/chat/completions \
-H "Content-Type: application/json" \
-H "x-portkey-api-key: <your-portkey-api-key>" \
-H "x-portkey-provider: @openai-prod" \
-d '{
"model": "gpt-4",
"messages": [{"role": "user", "content": "Hello from my private gateway!"}]
}'
4.4 See It in Action
β
Check Logs Visit app.portkey.ai β Logs
Your request appears instantly
β
View Analytics Visit app.portkey.ai β Analytics
See costs and latencies
π You Did It! Whatβs Next?
Add More Providers Connect Claude, Gemini, Llama, and 1600+ models
Set Up Fallbacks Add redundancy with automatic provider failover
Configure Caching Reduce costs by 40% with semantic caching
Production Checklist Security hardening and monitoring setup
π Book Your Success Review Optional: Show us your deployment and get optimization tips (15 min)
π Troubleshooting
π¬ Get Help Fast