diff --git a/docs.json b/docs.json index 002d8392..f8e916c1 100644 --- a/docs.json +++ b/docs.json @@ -10,918 +10,1846 @@ }, "favicon": "/favicon.png", "navigation": { - "tabs": [ + "versions":[ { - "tab": "Documentation", - "groups": [ + "version": "Using Model Catalog", + "tabs": [ { - "group": "Introduction", - "pages": [ - "introduction/what-is-portkey", - "introduction/make-your-first-request", - "introduction/feature-overview" + "tab": "Documentation", + "groups": [ + { + "group": "Introduction", + "pages": [ + "introduction/what-is-portkey", + "introduction/make-your-first-request", + "introduction/feature-overview" + ] + }, + { + "group": "Product", + "pages": [ + { + "group": "Observability", + "pages": [ + "product/observability", + "product/observability/logs", + "product/observability/traces", + "product/observability/analytics", + "product/observability/feedback", + "product/observability/metadata", + "product/observability/filters", + "product/observability/logs-export", + "product/observability/budget-limits", + "product/observability/auto-instrumentation" + ] + }, + { + "group": "AI Gateway", + "pages": [ + "product/ai-gateway", + "product/ai-gateway/universal-api", + "product/ai-gateway/configs", + "product/ai-gateway/remote-mcp", + "product/ai-gateway/conditional-routing", + { + "group": "Multimodal Capabilities", + "pages": [ + "product/ai-gateway/multimodal-capabilities", + "product/ai-gateway/multimodal-capabilities/image-generation", + "product/ai-gateway/multimodal-capabilities/function-calling", + "product/ai-gateway/multimodal-capabilities/vision", + "product/ai-gateway/multimodal-capabilities/text-to-speech", + "product/ai-gateway/multimodal-capabilities/speech-to-text", + "/product/ai-gateway/multimodal-capabilities/thinking-mode" + ] + }, + "product/ai-gateway/cache-simple-and-semantic", + "product/ai-gateway/fallbacks", + "product/ai-gateway/automatic-retries", + "product/ai-gateway/realtime-api", + "product/ai-gateway/load-balancing", + "product/ai-gateway/canary-testing", + "product/ai-gateway/strict-open-ai-compliance", + { + "group": "Virtual Keys [Deprecated]", + "pages": [ + "product/ai-gateway/virtual-keys", + "product/ai-gateway/virtual-keys/budget-limits", + "product/ai-gateway/virtual-keys/rate-limits", + "product/ai-gateway/virtual-keys/bedrock-amazon-assumed-role" + ] + }, + "product/ai-gateway/request-timeouts", + "product/ai-gateway/files", + "product/ai-gateway/batches", + "product/ai-gateway/fine-tuning" + ] + }, + { + "group": "Model Catalog", + "pages": [ + "product/model-catalog" + ] + }, + { + "group": "Integrations", + "pages": [ + "product/integrations", + "product/integrations/plugins", + "product/integrations/agents", + "product/integrations/guardrails", + "product/integrations/ai-apps", + "product/integrations/tracing", + "product/integrations/libraries", + "product/integrations/cloud" + ] + }, + { + "group": "Prompt Studio", + "pages": [ + "product/prompt-engineering-studio", + "product/prompt-engineering-studio/prompt-playground", + "product/prompt-engineering-studio/prompt-library", + "product/prompt-engineering-studio/prompt-versioning", + "product/prompt-engineering-studio/prompt-observability", + "product/prompt-engineering-studio/prompt-partial", + "product/prompt-engineering-studio/prompt-api", + "product/prompt-engineering-studio/tool-library", + "product/prompt-engineering-studio/prompt-integration", + "product/prompt-engineering-studio/prompt-guides" + ] + }, + { + "group": "Guardrails", + "pages": [ + "product/guardrails", + "product/guardrails/list-of-guardrail-checks", + "product/guardrails/embedding-guardrails", + "product/guardrails/creating-raw-guardrails-in-json", + "product/guardrails/pii-redaction", + "integrations/guardrails/bring-your-own-guardrails" + ] + }, + "product/mcp", + { + "group": "Administration", + "pages": [ + "product/administration/enforcing-request-metadata", + "product/administration/enforce-orgnization-level-guardrails", + "product/administration/enforce-workspace-level-guardials", + "product/administration/enforce-default-config", + "product/administration/enforce-budget-and-rate-limit", + "product/administration/configure-logs-access-permissions-in-workspace", + "product/administration/configure-virtual-key-access-permissions", + "product/administration/configure-api-key-access-permissions" + ] + }, + { + "group": "Security", + "pages": ["product/security/pii"] + }, + "product/autonomous-fine-tuning", + { + "group": "Enterprise Offering", + "pages": [ + "product/enterprise-offering", + { + "group": "Org Management", + "pages": [ + "product/enterprise-offering/org-management", + "product/enterprise-offering/org-management/organizations", + "product/enterprise-offering/org-management/workspaces", + "product/enterprise-offering/org-management/user-roles-and-permissions", + "product/enterprise-offering/org-management/api-keys-authn-and-authz", + "product/enterprise-offering/org-management/jwt", + { + "group": "SCIM", + "pages": [ + "product/enterprise-offering/org-management/scim/scim", + "product/enterprise-offering/org-management/scim/azure-ad", + "product/enterprise-offering/org-management/scim/okta" + ] + }, + "product/enterprise-offering/org-management/sso" + ] + }, + "product/enterprise-offering/access-control-management", + "product/enterprise-offering/budget-limits", + "product/enterprise-offering/security-portkey", + "product/enterprise-offering/analytics-logs-export", + "product/enterprise-offering/logs-export", + "/product/enterprise-offering/audit-logs", + { + "group": "Private Cloud Deployments", + "pages": [ + "product/enterprise-offering/private-cloud-deployments", + "product/enterprise-offering/private-cloud-deployments/architecture", + "product/enterprise-offering/private-cloud-deployments/aws", + "product/enterprise-offering/private-cloud-deployments/gcp", + "product/enterprise-offering/private-cloud-deployments/azure", + "product/enterprise-offering/private-cloud-deployments/cloudflare-workers", + "product/enterprise-offering/private-cloud-deployments/f5-app-stack" + ] + }, + "product/enterprise-offering/components", + "product/enterprise-offering/kms", + { + "group": "Cloud Marketplace", + "pages": [ + "product/enterprise-offering/cloud-marketplace/aws" + ] + } + ] + }, + "product/open-source", + "product/product-feature-comparison" + ] + }, + { + "group": "Support", + "pages": [ + "support/upgrade-to-model-catalog", + "README", + "support/contact-us", + "support/developer-forum", + "support/common-errors-and-resolutions", + "support/portkeys-december-migration" + ] + } ] }, { - "group": "Product", - "pages": [ + "tab": "Integrations", + "groups": [ + { + "group": "Ecosystem", + "pages": ["integrations/ecosystem", "integrations/partner"] + }, + { + "group": "LLM Integrations", + "pages": [ + "integrations/llms", + { + "group": "OpenAI", + "pages": [ + "integrations/llms/openai", + "integrations/llms/openai/structured-outputs", + "integrations/llms/openai/prompt-caching-openai", + "integrations/llms/openai/files", + "integrations/llms/openai/batches", + "integrations/llms/openai/fine-tuning" + ] + }, + { + "group": "Anthropic", + "pages": [ + "integrations/llms/anthropic", + "integrations/llms/anthropic/prompt-caching", + "integrations/llms/anthropic/computer-use" + ] + }, + "integrations/llms/gemini", + { + "group": "Google Vertex AI", + "pages": [ + "integrations/llms/vertex-ai", + "integrations/llms/vertex-ai/files", + "integrations/llms/vertex-ai/batches", + "integrations/llms/vertex-ai/fine-tuning", + "integrations/llms/vertex-ai/controlled-generations", + "integrations/llms/vertex-ai/embeddings" + ] + }, + { + "group": "Azure", + "pages": [ + "integrations/llms/azure-foundry", + "integrations/llms/azure-openai/azure-openai", + "integrations/llms/azure-openai/fine-tuning", + "integrations/llms/azure-openai/files", + "integrations/llms/azure-openai/batches" + ] + }, + { + "group": "Bedrock", + "pages": [ + "integrations/llms/bedrock/aws-bedrock", + "integrations/llms/bedrock/files", + "integrations/llms/bedrock/batches", + "integrations/llms/bedrock/fine-tuning", + "integrations/llms/bedrock/prompt-caching", + "integrations/llms/bedrock/embeddings" + ] + }, + "integrations/llms/aws-sagemaker", + "integrations/llms/ollama", + { + "group": "More", + "pages": [ + "integrations/llms/local-ai", + "integrations/llms/vllm", + "integrations/llms/triton", + "integrations/llms/ai21", + "integrations/llms/anyscale-llama2-mistral-zephyr", + "integrations/llms/cerebras", + "integrations/llms/cohere", + { + "group": "Fireworks", + "pages": [ + "integrations/llms/fireworks", + "integrations/llms/fireworks/files", + "integrations/llms/fireworks/fine-tuning" + ] + }, + "integrations/llms/dashscope", + "integrations/llms/deepinfra", + "integrations/llms/deepbricks", + "integrations/llms/deepgram", + "integrations/llms/deepseek", + "integrations/llms/github", + "integrations/llms/groq", + "integrations/llms/huggingface", + "integrations/llms/inference.net", + "integrations/llms/jina-ai", + "integrations/llms/lambda", + "integrations/llms/lemon-fox", + "integrations/llms/lepton", + "integrations/llms/lingyi-01.ai", + "integrations/llms/mistral-ai", + "integrations/llms/monster-api", + "integrations/llms/moonshot", + "integrations/llms/ncompass", + "integrations/llms/nomic", + "integrations/llms/nscale", + "integrations/llms/novita-ai", + "integrations/llms/nebius", + "integrations/llms/openrouter", + "integrations/llms/perplexity-ai", + "integrations/llms/predibase", + "integrations/llms/reka-ai", + "integrations/llms/recraft-ai", + "integrations/llms/sambanova", + "integrations/llms/segmind", + "integrations/llms/snowflake-cortex", + "integrations/llms/stability-ai", + "integrations/llms/siliconflow", + "integrations/llms/together-ai", + "integrations/llms/upstage", + "integrations/llms/voyage-ai", + "integrations/llms/workers-ai", + "integrations/llms/x-ai", + "integrations/llms/zhipu", + "integrations/llms/replicate", + "integrations/llms/suggest-a-new-integration" + ] + }, + "integrations/llms/byollm" + ] + }, + { + "group": "Cloud Platforms", + "pages": ["integrations/cloud/azure"] + }, + { + "group": "Guardrails", + "pages": [ + "integrations/guardrails/aporia", + "integrations/guardrails/acuvity", + "integrations/guardrails/azure-guardrails", + "integrations/guardrails/bedrock-guardrails", + "integrations/guardrails/lasso", + "integrations/guardrails/mistral", + "integrations/guardrails/pangea", + "integrations/guardrails/patronus-ai", + "integrations/guardrails/pillar", + "integrations/guardrails/prompt-security", + "integrations/guardrails/bring-your-own-guardrails" + ] + }, + { + "group": "Plugins", + "pages": ["integrations/plugins/exa"] + }, + { + "group": "Vector Databases", + "pages": [ + "integrations/vector-databases/milvus", + "integrations/vector-databases/qdrant" + ] + }, + { + "group": "Agents", + "pages": [ + "integrations/agents", + "integrations/agents/openai-agents", + "integrations/agents/openai-agents-ts", + "integrations/agents/autogen", + "integrations/agents/control-flow", + "integrations/agents/crewai", + "integrations/agents/langchain-agents", + "integrations/agents/langroid", + "integrations/agents/langgraph", + "integrations/agents/livekit", + "integrations/agents/llama-agents", + "integrations/agents/openai-swarm", + "integrations/agents/pydantic-ai", + "integrations/agents/phidata", + "integrations/agents/strands", + "integrations/agents/bring-your-own-agents" + ] + }, + { + "group": "AI Apps", + "pages": [ + "integrations/ai-apps", + "integrations/libraries/anythingllm", + "integrations/libraries/claude-code", + "integrations/libraries/anthropic-computer-use", + "integrations/libraries/cline", + "integrations/libraries/goose", + "integrations/libraries/janhq", + { + "group": "Librechat", + "pages": [ + "integrations/libraries/librechat", + "guides/use-cases/librechat-web-search" + ] + }, + "integrations/libraries/n8n", + "integrations/libraries/codex", + "integrations/libraries/openwebui", + "integrations/libraries/roo-code", + "integrations/libraries/zed" + ] + }, + { + "group": "Libraries", + "pages": [ + "integrations/libraries", + "integrations/libraries/autogen", + "integrations/libraries/dspy", + "integrations/libraries/instructor", + "integrations/libraries/langchain-python", + "integrations/libraries/langchain-js", + "integrations/libraries/llama-index-python", + "integrations/libraries/promptfoo", + "integrations/libraries/vercel", + "integrations/libraries/mindsdb", + "integrations/libraries/tooljet", + "integrations/libraries/mongodb", + "integrations/libraries/supabase", + "integrations/libraries/zed", + "integrations/libraries/openai-compatible", + "integrations/libraries/microsoft-semantic-kernel" + ] + }, + { + "group": "Tracing Providers", + "pages": [ + "integrations/tracing-providers/arize", + "integrations/tracing-providers/logfire" + ] + } + ] + }, + { + "tab": "Inference API", + "groups": [ + { + "group": "API Reference", + "pages": [ + "api-reference/inference-api/introduction", + "api-reference/inference-api/supported-providers", + "api-reference/inference-api/authentication", + "api-reference/inference-api/headers", + "api-reference/inference-api/error-codes", + "api-reference/inference-api/response-schema", + { + "group": "More", + "pages": [ + "api-reference/inference-api/config-object", + "api-reference/inference-api/open-api-specification" + ] + } + ] + }, + { + "group": "SDK", + "pages": [ + "api-reference/sdk/list", + "api-reference/sdk/python", + "api-reference/sdk/node", + "api-reference/sdk/c-sharp" + ] + }, + { + "group": "Chat Completions", + "pages": ["api-reference/inference-api/chat"] + }, + { + "group": "Responses", + "pages": [ + "api-reference/inference-api/responses/responses", + "api-reference/inference-api/responses/retrieve-response", + "api-reference/inference-api/responses/delete-response", + "api-reference/inference-api/responses/retrieve-inputs" + ] + }, + { + "group": "Portkey Endpoints", + "pages": [ + "api-reference/inference-api/prompts/prompt-completion", + "api-reference/inference-api/prompts/render", + "api-reference/admin-api/data-plane/logs/insert-a-log", + "api-reference/admin-api/data-plane/feedback/create-feedback", + "api-reference/admin-api/data-plane/feedback/update-feedback", + { + "group": "Log Exports", + "pages": [ + "api-reference/admin-api/data-plane/logs/log-exports-beta/retrieve-a-log-export", + "api-reference/admin-api/data-plane/logs/log-exports-beta/update-a-log-export", + "api-reference/admin-api/data-plane/logs/log-exports-beta/list-log-exports", + "api-reference/admin-api/data-plane/logs/log-exports-beta/create-a-log-export", + "api-reference/admin-api/data-plane/logs/log-exports-beta/start-a-log-export", + "api-reference/admin-api/data-plane/logs/log-exports-beta/cancel-a-log-export", + "api-reference/admin-api/data-plane/logs/log-exports-beta/download-a-log-export" + ] + } + ] + }, + { + "group": "Embeddings", + "pages": ["api-reference/inference-api/embeddings"] + }, + { + "group": "Images", + "pages": [ + "api-reference/inference-api/images/create-image", + "api-reference/inference-api/images/create-image-edit", + "api-reference/inference-api/images/create-image-variation" + ] + }, + { + "group": "Audio", + "pages": [ + "api-reference/inference-api/audio/create-speech", + "api-reference/inference-api/audio/create-transcription", + "api-reference/inference-api/audio/create-translation" + ] + }, + { + "group": "Other APIs", + "pages": ["api-reference/inference-api/gateway-for-other-apis"] + }, + { + "group": "Completions", + "pages": ["api-reference/inference-api/completions"] + }, + { + "group": "Moderations", + "pages": ["api-reference/inference-api/moderations"] + }, + { + "group": "Fine-tuning", + "pages": [ + "api-reference/inference-api/fine-tuning/create-fine-tuning-job", + "api-reference/inference-api/fine-tuning/list-fine-tuning-jobs", + "api-reference/inference-api/fine-tuning/retrieve-fine-tuning-job", + "api-reference/inference-api/fine-tuning/list-fine-tuning-events", + "api-reference/inference-api/fine-tuning/list-fine-tuning-checkpoints", + "api-reference/inference-api/fine-tuning/cancel-fine-tuning" + ] + }, + { + "group": "Batch", + "pages": [ + "api-reference/inference-api/batch/create-batch", + "api-reference/inference-api/batch/list-batch", + "api-reference/inference-api/batch/retrieve-batch", + "api-reference/inference-api/batch/cancel-batch" + ] + }, + { + "group": "Files", + "pages": [ + "api-reference/inference-api/files/upload-file", + "api-reference/inference-api/files/list-files", + "api-reference/inference-api/files/retrieve-file", + "api-reference/inference-api/files/retrieve-file-content", + "api-reference/inference-api/files/delete-file" + ] + }, + { + "group": "Assistants", + "pages": [ + { + "group": "Assistants", + "pages": [ + "api-reference/inference-api/assistants-api/assistants/create-assistant", + "api-reference/inference-api/assistants-api/assistants/list-assistants", + "api-reference/inference-api/assistants-api/assistants/retrieve-assistant", + "api-reference/inference-api/assistants-api/assistants/modify-assistant", + "api-reference/inference-api/assistants-api/assistants/delete-assistant" + ] + }, + { + "group": "Threads", + "pages": [ + "api-reference/inference-api/assistants-api/threads/create-thread", + "api-reference/inference-api/assistants-api/threads/retrieve-thread", + "api-reference/inference-api/assistants-api/threads/modify-thread", + "api-reference/inference-api/assistants-api/threads/delete-thread" + ] + }, + { + "group": "Messages", + "pages": [ + "api-reference/inference-api/assistants-api/messages/create-message", + "api-reference/inference-api/assistants-api/messages/list-messages", + "api-reference/inference-api/assistants-api/messages/retrieve-message", + "api-reference/inference-api/assistants-api/messages/modify-message", + "api-reference/inference-api/assistants-api/messages/delete-message" + ] + }, + { + "group": "Runs", + "pages": [ + "api-reference/inference-api/assistants-api/runs/create-run", + "api-reference/inference-api/assistants-api/runs/create-thread-and-run", + "api-reference/inference-api/assistants-api/runs/list-runs", + "api-reference/inference-api/assistants-api/runs/retrieve-run", + "api-reference/inference-api/assistants-api/runs/modify-run", + "api-reference/inference-api/assistants-api/runs/submit-tool-outputs-to-run", + "api-reference/inference-api/assistants-api/runs/cancel-run" + ] + }, + { + "group": "Run Steps", + "pages": [ + "api-reference/inference-api/assistants-api/run-steps/list-run-steps", + "api-reference/inference-api/assistants-api/run-steps/retrieve-run-steps" + ] + } + ] + } + ] + }, + { + "tab": "Admin API", + "groups": [ + { + "group": "API Reference", + "pages": ["api-reference/admin-api/introduction"] + }, + { + "group": "Configs", + "pages": [ + "api-reference/admin-api/control-plane/configs/create-config", + "api-reference/admin-api/control-plane/configs/list-configs", + "api-reference/admin-api/control-plane/configs/retrieve-config", + "api-reference/admin-api/control-plane/configs/update-config", + "api-reference/admin-api/control-plane/configs/delete-config" + ] + }, + { + "group": "Virtual Keys", + "pages": [ + "api-reference/admin-api/control-plane/virtual-keys/create-virtual-key", + "api-reference/admin-api/control-plane/virtual-keys/list-virtual-keys", + "api-reference/admin-api/control-plane/virtual-keys/retrieve-virtual-key", + "api-reference/admin-api/control-plane/virtual-keys/update-virtual-key", + "api-reference/admin-api/control-plane/virtual-keys/delete-virtual-key" + ] + }, + { + "group": "Prompts", + "pages": [ + "api-reference/admin-api/control-plane/prompts/create-prompt", + "api-reference/admin-api/control-plane/prompts/list-prompts", + "api-reference/admin-api/control-plane/prompts/retrieve-prompt", + "api-reference/admin-api/control-plane/prompts/update-prompt", + "api-reference/admin-api/control-plane/prompts/delete-prompt", + "api-reference/admin-api/control-plane/prompts/publish-prompt", + "api-reference/admin-api/control-plane/prompts/list-prompt-versions", + "api-reference/admin-api/control-plane/prompts/retrieve-prompt-version", + "api-reference/admin-api/control-plane/prompts/update-prompt-version", + { + "group": "Prompt Partials", + "pages": [ + "api-reference/admin-api/control-plane/prompts/partials/create-partial", + "api-reference/admin-api/control-plane/prompts/partials/list-partials", + "api-reference/admin-api/control-plane/prompts/partials/retrieve-partial", + "api-reference/admin-api/control-plane/prompts/partials/update-partial", + "api-reference/admin-api/control-plane/prompts/partials/delete-partial", + "api-reference/admin-api/control-plane/prompts/partials/list-partial-versions", + "api-reference/admin-api/control-plane/prompts/partials/publish-partial" + ] + }, + { + "group": "Prompt Labels", + "pages": [ + "api-reference/admin-api/control-plane/prompts/labels/create-label", + "api-reference/admin-api/control-plane/prompts/labels/list-labels", + "api-reference/admin-api/control-plane/prompts/labels/retrieve-label", + "api-reference/admin-api/control-plane/prompts/labels/update-label", + "api-reference/admin-api/control-plane/prompts/labels/delete-label" + ] + }, + { + "group": "Prompt Collections", + "pages": [ + "api-reference/admin-api/control-plane/prompts/collections/create-collection", + "api-reference/admin-api/control-plane/prompts/collections/list-collections", + "api-reference/admin-api/control-plane/prompts/collections/retrieve-collection", + "api-reference/admin-api/control-plane/prompts/collections/update-collection", + "api-reference/admin-api/control-plane/prompts/collections/delete-collection" + ] + } + ] + }, + { + "group": "API Keys", + "pages": [ + "api-reference/admin-api/control-plane/api-keys/update-api-key", + "api-reference/admin-api/control-plane/api-keys/create-api-key", + "api-reference/admin-api/control-plane/api-keys/delete-an-api-key", + "api-reference/admin-api/control-plane/api-keys/retrieve-an-api-key", + "api-reference/admin-api/control-plane/api-keys/list-api-keys" + ] + }, + { + "group": "Analytics [BETA]", + "pages": [ + { + "group": "Summary", + "pages": [ + "api-reference/admin-api/control-plane/analytics/summary/get-all-cache-data" + ] + }, + { + "group": "Groups Paginated Data", + "pages": [ + "api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-metadata-grouped-data", + "api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-model-grouped-data", + "api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-user-grouped-data" + ] + }, + { + "group": "Graphs - Time Series Data", + "pages": [ + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cache-hit-latency-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cache-hit-rate-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cost-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-error-rate-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-errors-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-per-ai-models-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-score-distribution-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-latency-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-requests-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-requests-per-user-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-rescued-requests-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-status-code-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-tokens-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-unique-status-code-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-users-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-weighted-feedback-data" + ] + } + ] + }, + { + "group": "Users", + "pages": [ + "api-reference/admin-api/control-plane/users/retrieve-a-user", + "api-reference/admin-api/control-plane/users/retrieve-all-users", + "api-reference/admin-api/control-plane/users/update-a-user", + "api-reference/admin-api/control-plane/users/remove-a-user" + ] + }, + { + "group": "User Invites", + "pages": [ + "api-reference/admin-api/control-plane/user-invites/invite-a-user", + "api-reference/admin-api/control-plane/user-invites/retrieve-an-invite", + "api-reference/admin-api/control-plane/user-invites/retrieve-all-user-invites", + "api-reference/admin-api/control-plane/user-invites/delete-a-user-invite", + "api-reference/admin-api/control-plane/user-invites/resend-a-user-invite" + ] + }, + { + "group": "Workspaces", + "pages": [ + "api-reference/admin-api/control-plane/workspaces/create-workspace", + "api-reference/admin-api/control-plane/workspaces/retrieve-all-workspaces", + "api-reference/admin-api/control-plane/workspaces/retrieve-a-workspace", + "api-reference/admin-api/control-plane/workspaces/update-workspace", + "api-reference/admin-api/control-plane/workspaces/delete-a-workspace" + ] + }, + { + "group": "Workspace Members", + "pages": [ + "api-reference/admin-api/control-plane/workspace-members/add-a-workspace-member", + "api-reference/admin-api/control-plane/workspace-members/retrieve-all-workspace-members", + "api-reference/admin-api/control-plane/workspace-members/retrieve-a-workspace-member", + "api-reference/admin-api/control-plane/workspace-members/update-workspace-member", + "api-reference/admin-api/control-plane/workspace-members/remove-workspace-member" + ] + }, + { + "group": "Audit Logs", + "pages": [ + "api-reference/admin-api/control-plane/audit-logs/list-audit-logs" + ] + }, + { + "group": "OpenAPI", + "pages": ["api-reference/admin-api/open-api-specification"] + } + ] + }, + { + "tab": "Cookbook", + "groups": [ + { + "group": "Evals", + "pages": [ + "guides/use-cases/run-batch-evals", + "guides/prompts/llm-as-a-judge" + ] + }, + { + "group": "Prompt Engineering", + "pages": [ + "guides/prompts", + "guides/prompts/ultimate-ai-sdr", + "guides/prompts/build-a-chatbot-using-portkeys-prompt-templates", + "guides/prompts/llm-as-a-judge", + "guides/prompts/llama-prompts" + ] + }, + { + "group": "Whitepapers", + "pages": [ + { + "group": "Optimizing LLM Costs", + "pages": [ + "guides/whitepapers/optimizing-llm-costs/executive-summary", + "guides/whitepapers/optimizing-llm-costs/introduction", + "guides/whitepapers/optimizing-llm-costs/llm-cost-drivers", + "guides/whitepapers/optimizing-llm-costs/frugalgpt-techniques", + "guides/whitepapers/optimizing-llm-costs/advanced-strategies", + "guides/whitepapers/optimizing-llm-costs/architectural-considerations", + "guides/whitepapers/optimizing-llm-costs/operational-best-practices", + "guides/whitepapers/optimizing-llm-costs/cost-effective-development", + "guides/whitepapers/optimizing-llm-costs/user-education", + "guides/whitepapers/optimizing-llm-costs/future-trends", + "guides/whitepapers/optimizing-llm-costs/conclusion-and-key-takeaways" + ] + } + ] + }, + { + "group": "Getting Started", + "pages": [ + "guides/getting-started", + "guides/getting-started/a-b-test-prompts-and-models", + "guides/getting-started/tackling-rate-limiting", + "guides/getting-started/function-calling", + "guides/getting-started/image-generation", + "guides/getting-started/getting-started-with-ai-gateway", + "guides/getting-started/llama-3-on-groq", + "guides/getting-started/return-repeat-requests-from-cache", + "guides/getting-started/trigger-automatic-retries-on-llm-failures", + "guides/getting-started/101-on-portkey-s-gateway-configs" + ] + }, + { + "group": "Integrations", + "pages": [ + "guides/integrations", + "guides/integrations/llama-3-on-portkey-+-together-ai", + "guides/integrations/introduction-to-gpt-4o", + "guides/integrations/anyscale", + "guides/integrations/mistral", + "guides/integrations/vercel-ai", + "guides/integrations/deepinfra", + "guides/integrations/groq", + "guides/integrations/langchain", + "guides/integrations/mixtral-8x22b", + "guides/integrations/segmind" + ] + }, + { + "group": "Use Cases", + "pages": [ + "guides/use-cases", + "guides/use-cases/librechat-web-search", + "guides/use-cases/few-shot-prompting", + "guides/use-cases/enforcing-json-schema-with-anyscale-and-together", + "guides/use-cases/emotions-with-gpt-4o", + "guides/use-cases/build-an-article-suggestion-app-with-supabase-pgvector-and-portkey", + "guides/use-cases/setting-up-resilient-load-balancers-with-failure-mitigating-fallbacks", + "guides/use-cases/run-portkey-on-prompts-from-langchain-hub", + "guides/use-cases/smart-fallback-with-model-optimized-prompts", + "guides/use-cases/how-to-use-openai-sdk-with-portkey-prompt-templates", + "guides/use-cases/setup-openai-greater-than-azure-openai-fallback", + "guides/use-cases/fallback-from-sdxl-to-dall-e-3", + "guides/use-cases/comparing-top10-lmsys-models-with-portkey", + "guides/use-cases/track-costs-using-metadata", + "guides/use-cases/deepseek-r1", + "guides/use-cases/openai-computer-use" + ] + } + ] + }, + { + "tab": "Changelog", + "groups": [ + { + "group": "Monthly Summary", + "pages": [ + { + "group": "2025", + "pages": [ + "changelog/2025/may", + "changelog/2025/apr", + "changelog/2025/mar", + "changelog/2025/feb", + "changelog/2025/jan" + ] + }, + { + "group": "2024", + "pages": [ + "changelog/2024/dec", + "changelog/2024/nov", + "changelog/2024/oct" + ] + } + ] + }, + { + "group": "Enterprise Releases", + "pages": ["changelog/enterprise", "changelog/helm-chart"] + }, + { + "group": "Product Releases", + "pages": ["changelog/product"] + }, + { + "group": "SDK Releases", + "pages": [ + "changelog/node-sdk-changelog", + "changelog/python-sdk-changelog" + ] + } + ] + } + ] + }, + { + "version": "Using Virtual Key", + "tabs": [ + { + "tab": "Documentation", + "groups": [ + { + "group": "Introduction", + "pages": [ + "introduction/what-is-portkey", + "introduction/make-your-first-request", + "introduction/feature-overview" + ] + }, + { + "group": "Product", + "pages": [ + { + "group": "Observability", + "pages": [ + "product/observability", + "product/observability/logs", + "product/observability/traces", + "product/observability/analytics", + "product/observability/feedback", + "product/observability/metadata", + "product/observability/filters", + "product/observability/logs-export", + "product/observability/budget-limits", + "product/observability/auto-instrumentation" + ] + }, + { + "group": "AI Gateway", + "pages": [ + "product/ai-gateway", + "product/ai-gateway/universal-api", + "product/ai-gateway/configs", + "product/ai-gateway/remote-mcp", + "product/ai-gateway/conditional-routing", + { + "group": "Multimodal Capabilities", + "pages": [ + "product/ai-gateway/multimodal-capabilities", + "product/ai-gateway/multimodal-capabilities/image-generation", + "product/ai-gateway/multimodal-capabilities/function-calling", + "product/ai-gateway/multimodal-capabilities/vision", + "product/ai-gateway/multimodal-capabilities/text-to-speech", + "product/ai-gateway/multimodal-capabilities/speech-to-text", + "/product/ai-gateway/multimodal-capabilities/thinking-mode" + ] + }, + "product/ai-gateway/cache-simple-and-semantic", + "product/ai-gateway/fallbacks", + "product/ai-gateway/automatic-retries", + "product/ai-gateway/realtime-api", + "product/ai-gateway/load-balancing", + "product/ai-gateway/canary-testing", + "product/ai-gateway/strict-open-ai-compliance", + { + "group": "Virtual Keys", + "pages": [ + "product/ai-gateway/virtual-keys", + "product/ai-gateway/virtual-keys/budget-limits", + "product/ai-gateway/virtual-keys/rate-limits", + "product/ai-gateway/virtual-keys/bedrock-amazon-assumed-role" + ] + }, + "product/ai-gateway/request-timeouts", + "product/ai-gateway/files", + "product/ai-gateway/batches", + "product/ai-gateway/fine-tuning" + ] + }, + { + "group": "Guardrails", + "pages": [ + "product/guardrails", + "product/guardrails/list-of-guardrail-checks", + "product/guardrails/embedding-guardrails", + "product/guardrails/creating-raw-guardrails-in-json", + "product/guardrails/pii-redaction", + "integrations/guardrails/bring-your-own-guardrails" + ] + }, + "product/mcp", + { + "group": "Administration", + "pages": [ + "product/administration/enforcing-request-metadata", + "product/administration/enforce-orgnization-level-guardrails", + "product/administration/enforce-workspace-level-guardials", + "product/administration/enforce-default-config", + "product/administration/enforce-budget-and-rate-limit", + "product/administration/configure-logs-access-permissions-in-workspace", + "product/administration/configure-virtual-key-access-permissions", + "product/administration/configure-api-key-access-permissions" + ] + }, + { + "group": "Security", + "pages": ["product/security/pii"] + }, + "product/autonomous-fine-tuning", + { + "group": "Enterprise Offering", + "pages": [ + "product/enterprise-offering", + { + "group": "Org Management", + "pages": [ + "product/enterprise-offering/org-management", + "product/enterprise-offering/org-management/organizations", + "product/enterprise-offering/org-management/workspaces", + "product/enterprise-offering/org-management/user-roles-and-permissions", + "product/enterprise-offering/org-management/api-keys-authn-and-authz", + "product/enterprise-offering/org-management/jwt", + { + "group": "SCIM", + "pages": [ + "product/enterprise-offering/org-management/scim/scim", + "product/enterprise-offering/org-management/scim/azure-ad", + "product/enterprise-offering/org-management/scim/okta" + ] + }, + "product/enterprise-offering/org-management/sso" + ] + }, + "product/enterprise-offering/access-control-management", + "product/enterprise-offering/budget-limits", + "product/enterprise-offering/security-portkey", + "product/enterprise-offering/analytics-logs-export", + "product/enterprise-offering/logs-export", + "/product/enterprise-offering/audit-logs", + { + "group": "Private Cloud Deployments", + "pages": [ + "product/enterprise-offering/private-cloud-deployments", + "product/enterprise-offering/private-cloud-deployments/architecture", + "product/enterprise-offering/private-cloud-deployments/aws", + "product/enterprise-offering/private-cloud-deployments/gcp", + "product/enterprise-offering/private-cloud-deployments/azure", + "product/enterprise-offering/private-cloud-deployments/cloudflare-workers", + "product/enterprise-offering/private-cloud-deployments/f5-app-stack" + ] + }, + "product/enterprise-offering/components", + "product/enterprise-offering/kms", + { + "group": "Cloud Marketplace", + "pages": [ + "product/enterprise-offering/cloud-marketplace/aws" + ] + } + ] + }, + "product/open-source", + "product/product-feature-comparison" + ] + }, + { + "group": "Support", + "pages": [ + "support/upgrade-to-model-catalog", + "README", + "support/contact-us", + "support/developer-forum", + "support/common-errors-and-resolutions", + "support/portkeys-december-migration" + ] + } + ] + }, + { + "tab": "Integrations", + "groups": [ + { + "group": "Ecosystem", + "pages": ["integrations/ecosystem", "integrations/partner"] + }, + { + "group": "LLM Integrations", + "pages": [ + "integrations/llms", + { + "group": "OpenAI", + "pages": [ + "integrations/llms/openai", + "integrations/llms/openai/structured-outputs", + "integrations/llms/openai/prompt-caching-openai", + "integrations/llms/openai/files", + "integrations/llms/openai/batches", + "integrations/llms/openai/fine-tuning" + ] + }, + { + "group": "Anthropic", + "pages": [ + "integrations/llms/anthropic", + "integrations/llms/anthropic/prompt-caching", + "integrations/llms/anthropic/computer-use" + ] + }, + "integrations/llms/gemini", + { + "group": "Google Vertex AI", + "pages": [ + "integrations/llms/vertex-ai", + "integrations/llms/vertex-ai/files", + "integrations/llms/vertex-ai/batches", + "integrations/llms/vertex-ai/fine-tuning", + "integrations/llms/vertex-ai/controlled-generations", + "integrations/llms/vertex-ai/embeddings" + ] + }, + { + "group": "Azure", + "pages": [ + "integrations/llms/azure-foundry", + "integrations/llms/azure-openai/azure-openai", + "integrations/llms/azure-openai/fine-tuning", + "integrations/llms/azure-openai/files", + "integrations/llms/azure-openai/batches" + ] + }, + { + "group": "Bedrock", + "pages": [ + "integrations/llms/bedrock/aws-bedrock", + "integrations/llms/bedrock/files", + "integrations/llms/bedrock/batches", + "integrations/llms/bedrock/fine-tuning", + "integrations/llms/bedrock/prompt-caching", + "integrations/llms/bedrock/embeddings" + ] + }, + "integrations/llms/aws-sagemaker", + "integrations/llms/ollama", + { + "group": "More", + "pages": [ + "integrations/llms/local-ai", + "integrations/llms/vllm", + "integrations/llms/triton", + "integrations/llms/ai21", + "integrations/llms/anyscale-llama2-mistral-zephyr", + "integrations/llms/cerebras", + "integrations/llms/cohere", + { + "group": "Fireworks", + "pages": [ + "integrations/llms/fireworks", + "integrations/llms/fireworks/files", + "integrations/llms/fireworks/fine-tuning" + ] + }, + "integrations/llms/dashscope", + "integrations/llms/deepinfra", + "integrations/llms/deepbricks", + "integrations/llms/deepgram", + "integrations/llms/deepseek", + "integrations/llms/github", + "integrations/llms/groq", + "integrations/llms/huggingface", + "integrations/llms/inference.net", + "integrations/llms/jina-ai", + "integrations/llms/lambda", + "integrations/llms/lemon-fox", + "integrations/llms/lepton", + "integrations/llms/lingyi-01.ai", + "integrations/llms/mistral-ai", + "integrations/llms/monster-api", + "integrations/llms/moonshot", + "integrations/llms/ncompass", + "integrations/llms/nomic", + "integrations/llms/nscale", + "integrations/llms/novita-ai", + "integrations/llms/nebius", + "integrations/llms/openrouter", + "integrations/llms/perplexity-ai", + "integrations/llms/predibase", + "integrations/llms/reka-ai", + "integrations/llms/recraft-ai", + "integrations/llms/sambanova", + "integrations/llms/segmind", + "integrations/llms/snowflake-cortex", + "integrations/llms/stability-ai", + "integrations/llms/siliconflow", + "integrations/llms/together-ai", + "integrations/llms/upstage", + "integrations/llms/voyage-ai", + "integrations/llms/workers-ai", + "integrations/llms/x-ai", + "integrations/llms/zhipu", + "integrations/llms/replicate", + "integrations/llms/suggest-a-new-integration" + ] + }, + "integrations/llms/byollm" + ] + }, + { + "group": "Cloud Platforms", + "pages": ["integrations/cloud/azure"] + }, + { + "group": "Guardrails", + "pages": [ + "integrations/guardrails/aporia", + "integrations/guardrails/acuvity", + "integrations/guardrails/azure-guardrails", + "integrations/guardrails/bedrock-guardrails", + "integrations/guardrails/lasso", + "integrations/guardrails/mistral", + "integrations/guardrails/pangea", + "integrations/guardrails/patronus-ai", + "integrations/guardrails/pillar", + "integrations/guardrails/prompt-security", + "integrations/guardrails/bring-your-own-guardrails" + ] + }, + { + "group": "Plugins", + "pages": ["integrations/plugins/exa"] + }, + { + "group": "Vector Databases", + "pages": [ + "integrations/vector-databases/milvus", + "integrations/vector-databases/qdrant" + ] + }, { - "group": "Observability", + "group": "Agents", "pages": [ - "product/observability", - "product/observability/logs", - "product/observability/traces", - "product/observability/analytics", - "product/observability/feedback", - "product/observability/metadata", - "product/observability/filters", - "product/observability/logs-export", - "product/observability/budget-limits", - "product/observability/auto-instrumentation" + "integrations/agents", + "integrations/agents/openai-agents", + "integrations/agents/openai-agents-ts", + "integrations/agents/autogen", + "integrations/agents/control-flow", + "integrations/agents/crewai", + "integrations/agents/langchain-agents", + "integrations/agents/langroid", + "integrations/agents/langgraph", + "integrations/agents/livekit", + "integrations/agents/llama-agents", + "integrations/agents/openai-swarm", + "integrations/agents/pydantic-ai", + "integrations/agents/phidata", + "integrations/agents/strands", + "integrations/agents/bring-your-own-agents" ] }, { - "group": "AI Gateway", + "group": "AI Apps", "pages": [ - "product/ai-gateway", - "product/ai-gateway/universal-api", - "product/ai-gateway/configs", - "product/ai-gateway/remote-mcp", - "product/ai-gateway/conditional-routing", + "integrations/ai-apps", + "integrations/libraries/anythingllm", + "integrations/libraries/claude-code", + "integrations/libraries/anthropic-computer-use", + "integrations/libraries/cline", + "integrations/libraries/goose", + "integrations/libraries/janhq", { - "group": "Multimodal Capabilities", + "group": "Librechat", "pages": [ - "product/ai-gateway/multimodal-capabilities", - "product/ai-gateway/multimodal-capabilities/image-generation", - "product/ai-gateway/multimodal-capabilities/function-calling", - "product/ai-gateway/multimodal-capabilities/vision", - "product/ai-gateway/multimodal-capabilities/text-to-speech", - "product/ai-gateway/multimodal-capabilities/speech-to-text", - "/product/ai-gateway/multimodal-capabilities/thinking-mode" + "integrations/libraries/librechat", + "guides/use-cases/librechat-web-search" ] }, - "product/ai-gateway/cache-simple-and-semantic", - "product/ai-gateway/fallbacks", - "product/ai-gateway/automatic-retries", - "product/ai-gateway/realtime-api", - "product/ai-gateway/load-balancing", - "product/ai-gateway/canary-testing", - "product/ai-gateway/strict-open-ai-compliance", + "integrations/libraries/n8n", + "integrations/libraries/codex", + "integrations/libraries/openwebui", + "integrations/libraries/roo-code", + "integrations/libraries/zed" + ] + }, + { + "group": "Libraries", + "pages": [ + "integrations/libraries", + "integrations/libraries/autogen", + "integrations/libraries/dspy", + "integrations/libraries/instructor", + "integrations/libraries/langchain-python", + "integrations/libraries/langchain-js", + "integrations/libraries/llama-index-python", + "integrations/libraries/promptfoo", + "integrations/libraries/vercel", + "integrations/libraries/mindsdb", + "integrations/libraries/tooljet", + "integrations/libraries/mongodb", + "integrations/libraries/supabase", + "integrations/libraries/zed", + "integrations/libraries/openai-compatible", + "integrations/libraries/microsoft-semantic-kernel" + ] + }, + { + "group": "Tracing Providers", + "pages": [ + "integrations/tracing-providers/arize", + "integrations/tracing-providers/logfire" + ] + } + ] + }, + { + "tab": "Inference API", + "groups": [ + { + "group": "API Reference", + "pages": [ + "api-reference/inference-api/introduction", + "api-reference/inference-api/supported-providers", + "api-reference/inference-api/authentication", + "api-reference/inference-api/headers", + "api-reference/inference-api/error-codes", + "api-reference/inference-api/response-schema", { - "group": "Virtual Keys [Deprecated]", + "group": "More", "pages": [ - "product/ai-gateway/virtual-keys", - "product/ai-gateway/virtual-keys/budget-limits", - "product/ai-gateway/virtual-keys/rate-limits", - "product/ai-gateway/virtual-keys/bedrock-amazon-assumed-role" + "api-reference/inference-api/config-object", + "api-reference/inference-api/open-api-specification" ] - }, - "product/ai-gateway/request-timeouts", - "product/ai-gateway/files", - "product/ai-gateway/batches", - "product/ai-gateway/fine-tuning" + } ] }, { - "group": "Prompt Studio", + "group": "SDK", "pages": [ - "product/prompt-engineering-studio", - "product/prompt-engineering-studio/prompt-playground", - "product/prompt-engineering-studio/prompt-library", - "product/prompt-engineering-studio/prompt-versioning", - "product/prompt-engineering-studio/prompt-observability", - "product/prompt-engineering-studio/prompt-partial", - "product/prompt-engineering-studio/prompt-api", - "product/prompt-engineering-studio/tool-library", - "product/prompt-engineering-studio/prompt-integration", - "product/prompt-engineering-studio/prompt-guides" + "api-reference/sdk/list", + "api-reference/sdk/python", + "api-reference/sdk/node", + "api-reference/sdk/c-sharp" ] }, { - "group": "Guardrails", + "group": "Chat Completions", + "pages": ["api-reference/inference-api/chat"] + }, + { + "group": "Responses", "pages": [ - "product/guardrails", - "product/guardrails/list-of-guardrail-checks", - "product/guardrails/embedding-guardrails", - "product/guardrails/creating-raw-guardrails-in-json", - "product/guardrails/pii-redaction", - "integrations/guardrails/bring-your-own-guardrails" + "api-reference/inference-api/responses/responses", + "api-reference/inference-api/responses/retrieve-response", + "api-reference/inference-api/responses/delete-response", + "api-reference/inference-api/responses/retrieve-inputs" + ] + }, + { + "group": "Portkey Endpoints", + "pages": [ + "api-reference/inference-api/prompts/prompt-completion", + "api-reference/inference-api/prompts/render", + "api-reference/admin-api/data-plane/logs/insert-a-log", + "api-reference/admin-api/data-plane/feedback/create-feedback", + "api-reference/admin-api/data-plane/feedback/update-feedback", + { + "group": "Log Exports", + "pages": [ + "api-reference/admin-api/data-plane/logs/log-exports-beta/retrieve-a-log-export", + "api-reference/admin-api/data-plane/logs/log-exports-beta/update-a-log-export", + "api-reference/admin-api/data-plane/logs/log-exports-beta/list-log-exports", + "api-reference/admin-api/data-plane/logs/log-exports-beta/create-a-log-export", + "api-reference/admin-api/data-plane/logs/log-exports-beta/start-a-log-export", + "api-reference/admin-api/data-plane/logs/log-exports-beta/cancel-a-log-export", + "api-reference/admin-api/data-plane/logs/log-exports-beta/download-a-log-export" + ] + } + ] + }, + { + "group": "Embeddings", + "pages": ["api-reference/inference-api/embeddings"] + }, + { + "group": "Images", + "pages": [ + "api-reference/inference-api/images/create-image", + "api-reference/inference-api/images/create-image-edit", + "api-reference/inference-api/images/create-image-variation" + ] + }, + { + "group": "Audio", + "pages": [ + "api-reference/inference-api/audio/create-speech", + "api-reference/inference-api/audio/create-transcription", + "api-reference/inference-api/audio/create-translation" + ] + }, + { + "group": "Other APIs", + "pages": ["api-reference/inference-api/gateway-for-other-apis"] + }, + { + "group": "Completions", + "pages": ["api-reference/inference-api/completions"] + }, + { + "group": "Moderations", + "pages": ["api-reference/inference-api/moderations"] + }, + { + "group": "Fine-tuning", + "pages": [ + "api-reference/inference-api/fine-tuning/create-fine-tuning-job", + "api-reference/inference-api/fine-tuning/list-fine-tuning-jobs", + "api-reference/inference-api/fine-tuning/retrieve-fine-tuning-job", + "api-reference/inference-api/fine-tuning/list-fine-tuning-events", + "api-reference/inference-api/fine-tuning/list-fine-tuning-checkpoints", + "api-reference/inference-api/fine-tuning/cancel-fine-tuning" ] }, - "product/mcp", { - "group": "Administration", + "group": "Batch", "pages": [ - "product/administration/enforcing-request-metadata", - "product/administration/enforce-orgnization-level-guardrails", - "product/administration/enforce-workspace-level-guardials", - "product/administration/enforce-default-config", - "product/administration/enforce-budget-and-rate-limit", - "product/administration/configure-logs-access-permissions-in-workspace", - "product/administration/configure-virtual-key-access-permissions", - "product/administration/configure-api-key-access-permissions" + "api-reference/inference-api/batch/create-batch", + "api-reference/inference-api/batch/list-batch", + "api-reference/inference-api/batch/retrieve-batch", + "api-reference/inference-api/batch/cancel-batch" ] }, { - "group": "Security", - "pages": ["product/security/pii"] + "group": "Files", + "pages": [ + "api-reference/inference-api/files/upload-file", + "api-reference/inference-api/files/list-files", + "api-reference/inference-api/files/retrieve-file", + "api-reference/inference-api/files/retrieve-file-content", + "api-reference/inference-api/files/delete-file" + ] }, - "product/autonomous-fine-tuning", { - "group": "Enterprise Offering", + "group": "Assistants", "pages": [ - "product/enterprise-offering", { - "group": "Org Management", + "group": "Assistants", "pages": [ - "product/enterprise-offering/org-management", - "product/enterprise-offering/org-management/organizations", - "product/enterprise-offering/org-management/workspaces", - "product/enterprise-offering/org-management/user-roles-and-permissions", - "product/enterprise-offering/org-management/api-keys-authn-and-authz", - "product/enterprise-offering/org-management/jwt", - { - "group": "SCIM", - "pages": [ - "product/enterprise-offering/org-management/scim/scim", - "product/enterprise-offering/org-management/scim/azure-ad", - "product/enterprise-offering/org-management/scim/okta" - ] - }, - "product/enterprise-offering/org-management/sso" + "api-reference/inference-api/assistants-api/assistants/create-assistant", + "api-reference/inference-api/assistants-api/assistants/list-assistants", + "api-reference/inference-api/assistants-api/assistants/retrieve-assistant", + "api-reference/inference-api/assistants-api/assistants/modify-assistant", + "api-reference/inference-api/assistants-api/assistants/delete-assistant" + ] + }, + { + "group": "Threads", + "pages": [ + "api-reference/inference-api/assistants-api/threads/create-thread", + "api-reference/inference-api/assistants-api/threads/retrieve-thread", + "api-reference/inference-api/assistants-api/threads/modify-thread", + "api-reference/inference-api/assistants-api/threads/delete-thread" + ] + }, + { + "group": "Messages", + "pages": [ + "api-reference/inference-api/assistants-api/messages/create-message", + "api-reference/inference-api/assistants-api/messages/list-messages", + "api-reference/inference-api/assistants-api/messages/retrieve-message", + "api-reference/inference-api/assistants-api/messages/modify-message", + "api-reference/inference-api/assistants-api/messages/delete-message" ] }, - "product/enterprise-offering/access-control-management", - "product/enterprise-offering/budget-limits", - "product/enterprise-offering/security-portkey", - "product/enterprise-offering/analytics-logs-export", - "product/enterprise-offering/logs-export", - "/product/enterprise-offering/audit-logs", { - "group": "Private Cloud Deployments", + "group": "Runs", "pages": [ - "product/enterprise-offering/private-cloud-deployments", - "product/enterprise-offering/private-cloud-deployments/architecture", - "product/enterprise-offering/private-cloud-deployments/aws", - "product/enterprise-offering/private-cloud-deployments/gcp", - "product/enterprise-offering/private-cloud-deployments/azure", - "product/enterprise-offering/private-cloud-deployments/cloudflare-workers", - "product/enterprise-offering/private-cloud-deployments/f5-app-stack" + "api-reference/inference-api/assistants-api/runs/create-run", + "api-reference/inference-api/assistants-api/runs/create-thread-and-run", + "api-reference/inference-api/assistants-api/runs/list-runs", + "api-reference/inference-api/assistants-api/runs/retrieve-run", + "api-reference/inference-api/assistants-api/runs/modify-run", + "api-reference/inference-api/assistants-api/runs/submit-tool-outputs-to-run", + "api-reference/inference-api/assistants-api/runs/cancel-run" ] }, - "product/enterprise-offering/components", - "product/enterprise-offering/kms", { - "group": "Cloud Marketplace", + "group": "Run Steps", "pages": [ - "product/enterprise-offering/cloud-marketplace/aws" + "api-reference/inference-api/assistants-api/run-steps/list-run-steps", + "api-reference/inference-api/assistants-api/run-steps/retrieve-run-steps" ] } ] - }, - "product/open-source", - "product/product-feature-comparison" - ] - }, - { - "group": "Support", - "pages": [ - "support/upgrade-to-model-catalog", - "README", - "support/contact-us", - "support/developer-forum", - "support/common-errors-and-resolutions", - "support/portkeys-december-migration" + } ] - } - ] - }, - { - "tab": "Integrations", - "groups": [ - { - "group": "Ecosystem", - "pages": ["integrations/ecosystem", "integrations/partner"] }, { - "group": "LLM Integrations", - "pages": [ - "integrations/llms", + "tab": "Admin API", + "groups": [ { - "group": "OpenAI", - "pages": [ - "integrations/llms/openai", - "integrations/llms/openai/structured-outputs", - "integrations/llms/openai/prompt-caching-openai", - "integrations/llms/openai/files", - "integrations/llms/openai/batches", - "integrations/llms/openai/fine-tuning" - ] + "group": "API Reference", + "pages": ["api-reference/admin-api/introduction"] }, { - "group": "Anthropic", + "group": "Configs", "pages": [ - "integrations/llms/anthropic", - "integrations/llms/anthropic/prompt-caching", - "integrations/llms/anthropic/computer-use" + "api-reference/admin-api/control-plane/configs/create-config", + "api-reference/admin-api/control-plane/configs/list-configs", + "api-reference/admin-api/control-plane/configs/retrieve-config", + "api-reference/admin-api/control-plane/configs/update-config", + "api-reference/admin-api/control-plane/configs/delete-config" ] }, - "integrations/llms/gemini", { - "group": "Google Vertex AI", + "group": "Virtual Keys", "pages": [ - "integrations/llms/vertex-ai", - "integrations/llms/vertex-ai/files", - "integrations/llms/vertex-ai/batches", - "integrations/llms/vertex-ai/fine-tuning", - "integrations/llms/vertex-ai/controlled-generations", - "integrations/llms/vertex-ai/embeddings" + "api-reference/admin-api/control-plane/virtual-keys/create-virtual-key", + "api-reference/admin-api/control-plane/virtual-keys/list-virtual-keys", + "api-reference/admin-api/control-plane/virtual-keys/retrieve-virtual-key", + "api-reference/admin-api/control-plane/virtual-keys/update-virtual-key", + "api-reference/admin-api/control-plane/virtual-keys/delete-virtual-key" ] }, { - "group": "Azure", + "group": "Prompts", "pages": [ - "integrations/llms/azure-foundry", - "integrations/llms/azure-openai/azure-openai", - "integrations/llms/azure-openai/fine-tuning", - "integrations/llms/azure-openai/files", - "integrations/llms/azure-openai/batches" + "api-reference/admin-api/control-plane/prompts/create-prompt", + "api-reference/admin-api/control-plane/prompts/list-prompts", + "api-reference/admin-api/control-plane/prompts/retrieve-prompt", + "api-reference/admin-api/control-plane/prompts/update-prompt", + "api-reference/admin-api/control-plane/prompts/delete-prompt", + "api-reference/admin-api/control-plane/prompts/publish-prompt", + "api-reference/admin-api/control-plane/prompts/list-prompt-versions", + "api-reference/admin-api/control-plane/prompts/retrieve-prompt-version", + "api-reference/admin-api/control-plane/prompts/update-prompt-version", + { + "group": "Prompt Partials", + "pages": [ + "api-reference/admin-api/control-plane/prompts/partials/create-partial", + "api-reference/admin-api/control-plane/prompts/partials/list-partials", + "api-reference/admin-api/control-plane/prompts/partials/retrieve-partial", + "api-reference/admin-api/control-plane/prompts/partials/update-partial", + "api-reference/admin-api/control-plane/prompts/partials/delete-partial", + "api-reference/admin-api/control-plane/prompts/partials/list-partial-versions", + "api-reference/admin-api/control-plane/prompts/partials/publish-partial" + ] + }, + { + "group": "Prompt Labels", + "pages": [ + "api-reference/admin-api/control-plane/prompts/labels/create-label", + "api-reference/admin-api/control-plane/prompts/labels/list-labels", + "api-reference/admin-api/control-plane/prompts/labels/retrieve-label", + "api-reference/admin-api/control-plane/prompts/labels/update-label", + "api-reference/admin-api/control-plane/prompts/labels/delete-label" + ] + }, + { + "group": "Prompt Collections", + "pages": [ + "api-reference/admin-api/control-plane/prompts/collections/create-collection", + "api-reference/admin-api/control-plane/prompts/collections/list-collections", + "api-reference/admin-api/control-plane/prompts/collections/retrieve-collection", + "api-reference/admin-api/control-plane/prompts/collections/update-collection", + "api-reference/admin-api/control-plane/prompts/collections/delete-collection" + ] + } ] }, { - "group": "Bedrock", + "group": "API Keys", "pages": [ - "integrations/llms/bedrock/aws-bedrock", - "integrations/llms/bedrock/files", - "integrations/llms/bedrock/batches", - "integrations/llms/bedrock/fine-tuning", - "integrations/llms/bedrock/prompt-caching", - "integrations/llms/bedrock/embeddings" + "api-reference/admin-api/control-plane/api-keys/update-api-key", + "api-reference/admin-api/control-plane/api-keys/create-api-key", + "api-reference/admin-api/control-plane/api-keys/delete-an-api-key", + "api-reference/admin-api/control-plane/api-keys/retrieve-an-api-key", + "api-reference/admin-api/control-plane/api-keys/list-api-keys" ] }, - "integrations/llms/aws-sagemaker", - "integrations/llms/ollama", { - "group": "More", + "group": "Analytics [BETA]", "pages": [ - "integrations/llms/local-ai", - "integrations/llms/vllm", - "integrations/llms/triton", - "integrations/llms/ai21", - "integrations/llms/anyscale-llama2-mistral-zephyr", - "integrations/llms/cerebras", - "integrations/llms/cohere", { - "group": "Fireworks", + "group": "Summary", "pages": [ - "integrations/llms/fireworks", - "integrations/llms/fireworks/files", - "integrations/llms/fireworks/fine-tuning" + "api-reference/admin-api/control-plane/analytics/summary/get-all-cache-data" ] }, - "integrations/llms/dashscope", - "integrations/llms/deepinfra", - "integrations/llms/deepbricks", - "integrations/llms/deepgram", - "integrations/llms/deepseek", - "integrations/llms/github", - "integrations/llms/groq", - "integrations/llms/huggingface", - "integrations/llms/inference.net", - "integrations/llms/jina-ai", - "integrations/llms/lambda", - "integrations/llms/lemon-fox", - "integrations/llms/lepton", - "integrations/llms/lingyi-01.ai", - "integrations/llms/mistral-ai", - "integrations/llms/monster-api", - "integrations/llms/moonshot", - "integrations/llms/ncompass", - "integrations/llms/nomic", - "integrations/llms/nscale", - "integrations/llms/novita-ai", - "integrations/llms/nebius", - "integrations/llms/openrouter", - "integrations/llms/perplexity-ai", - "integrations/llms/predibase", - "integrations/llms/reka-ai", - "integrations/llms/recraft-ai", - "integrations/llms/sambanova", - "integrations/llms/segmind", - "integrations/llms/snowflake-cortex", - "integrations/llms/stability-ai", - "integrations/llms/siliconflow", - "integrations/llms/together-ai", - "integrations/llms/upstage", - "integrations/llms/voyage-ai", - "integrations/llms/workers-ai", - "integrations/llms/x-ai", - "integrations/llms/zhipu", - "integrations/llms/replicate", - "integrations/llms/suggest-a-new-integration" - ] - }, - "integrations/llms/byollm" - ] - }, - { - "group": "Cloud Platforms", - "pages": ["integrations/cloud/azure"] - }, - { - "group": "Guardrails", - "pages": [ - "integrations/guardrails/aporia", - "integrations/guardrails/acuvity", - "integrations/guardrails/azure-guardrails", - "integrations/guardrails/bedrock-guardrails", - "integrations/guardrails/lasso", - "integrations/guardrails/mistral", - "integrations/guardrails/pangea", - "integrations/guardrails/patronus-ai", - "integrations/guardrails/pillar", - "integrations/guardrails/prompt-security", - "integrations/guardrails/bring-your-own-guardrails" - ] - }, - { - "group": "Plugins", - "pages": ["integrations/plugins/exa"] - }, - { - "group": "Vector Databases", - "pages": [ - "integrations/vector-databases/milvus", - "integrations/vector-databases/qdrant" - ] - }, - { - "group": "Agents", - "pages": [ - "integrations/agents", - "integrations/agents/openai-agents", - "integrations/agents/openai-agents-ts", - "integrations/agents/autogen", - "integrations/agents/control-flow", - "integrations/agents/crewai", - "integrations/agents/langchain-agents", - "integrations/agents/langroid", - "integrations/agents/langgraph", - "integrations/agents/livekit", - "integrations/agents/llama-agents", - "integrations/agents/openai-swarm", - "integrations/agents/pydantic-ai", - "integrations/agents/phidata", - "integrations/agents/strands", - "integrations/agents/bring-your-own-agents" - ] - }, - { - "group": "AI Apps", - "pages": [ - "integrations/ai-apps", - "integrations/libraries/anythingllm", - "integrations/libraries/claude-code", - "integrations/libraries/anthropic-computer-use", - "integrations/libraries/cline", - "integrations/libraries/goose", - "integrations/libraries/janhq", - { - "group": "Librechat", - "pages": [ - "integrations/libraries/librechat", - "guides/use-cases/librechat-web-search" - ] - }, - "integrations/libraries/n8n", - "integrations/libraries/codex", - "integrations/libraries/openwebui", - "integrations/libraries/roo-code", - "integrations/libraries/zed" - ] - }, - { - "group": "Libraries", - "pages": [ - "integrations/libraries", - "integrations/libraries/autogen", - "integrations/libraries/dspy", - "integrations/libraries/instructor", - "integrations/libraries/langchain-python", - "integrations/libraries/langchain-js", - "integrations/libraries/llama-index-python", - "integrations/libraries/promptfoo", - "integrations/libraries/vercel", - "integrations/libraries/mindsdb", - "integrations/libraries/tooljet", - "integrations/libraries/mongodb", - "integrations/libraries/supabase", - "integrations/libraries/zed", - "integrations/libraries/openai-compatible", - "integrations/libraries/microsoft-semantic-kernel" - ] - }, - { - "group": "Tracing Providers", - "pages": [ - "integrations/tracing-providers/arize", - "integrations/tracing-providers/logfire" - ] - } - ] - }, - { - "tab": "Inference API", - "groups": [ - { - "group": "API Reference", - "pages": [ - "api-reference/inference-api/introduction", - "api-reference/inference-api/supported-providers", - "api-reference/inference-api/authentication", - "api-reference/inference-api/headers", - "api-reference/inference-api/error-codes", - "api-reference/inference-api/response-schema", - { - "group": "More", - "pages": [ - "api-reference/inference-api/config-object", - "api-reference/inference-api/open-api-specification" - ] - } - ] - }, - { - "group": "SDK", - "pages": [ - "api-reference/sdk/list", - "api-reference/sdk/python", - "api-reference/sdk/node", - "api-reference/sdk/c-sharp" - ] - }, - { - "group": "Chat Completions", - "pages": ["api-reference/inference-api/chat"] - }, - { - "group": "Responses", - "pages": [ - "api-reference/inference-api/responses/responses", - "api-reference/inference-api/responses/retrieve-response", - "api-reference/inference-api/responses/delete-response", - "api-reference/inference-api/responses/retrieve-inputs" - ] - }, - { - "group": "Portkey Endpoints", - "pages": [ - "api-reference/inference-api/prompts/prompt-completion", - "api-reference/inference-api/prompts/render", - "api-reference/admin-api/data-plane/logs/insert-a-log", - "api-reference/admin-api/data-plane/feedback/create-feedback", - "api-reference/admin-api/data-plane/feedback/update-feedback", - { - "group": "Log Exports", - "pages": [ - "api-reference/admin-api/data-plane/logs/log-exports-beta/retrieve-a-log-export", - "api-reference/admin-api/data-plane/logs/log-exports-beta/update-a-log-export", - "api-reference/admin-api/data-plane/logs/log-exports-beta/list-log-exports", - "api-reference/admin-api/data-plane/logs/log-exports-beta/create-a-log-export", - "api-reference/admin-api/data-plane/logs/log-exports-beta/start-a-log-export", - "api-reference/admin-api/data-plane/logs/log-exports-beta/cancel-a-log-export", - "api-reference/admin-api/data-plane/logs/log-exports-beta/download-a-log-export" + { + "group": "Groups Paginated Data", + "pages": [ + "api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-metadata-grouped-data", + "api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-model-grouped-data", + "api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-user-grouped-data" + ] + }, + { + "group": "Graphs - Time Series Data", + "pages": [ + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cache-hit-latency-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cache-hit-rate-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cost-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-error-rate-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-errors-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-per-ai-models-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-score-distribution-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-latency-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-requests-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-requests-per-user-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-rescued-requests-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-status-code-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-tokens-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-unique-status-code-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-users-data", + "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-weighted-feedback-data" + ] + } ] - } - ] - }, - { - "group": "Embeddings", - "pages": ["api-reference/inference-api/embeddings"] - }, - { - "group": "Images", - "pages": [ - "api-reference/inference-api/images/create-image", - "api-reference/inference-api/images/create-image-edit", - "api-reference/inference-api/images/create-image-variation" - ] - }, - { - "group": "Audio", - "pages": [ - "api-reference/inference-api/audio/create-speech", - "api-reference/inference-api/audio/create-transcription", - "api-reference/inference-api/audio/create-translation" - ] - }, - { - "group": "Other APIs", - "pages": ["api-reference/inference-api/gateway-for-other-apis"] - }, - { - "group": "Completions", - "pages": ["api-reference/inference-api/completions"] - }, - { - "group": "Moderations", - "pages": ["api-reference/inference-api/moderations"] - }, - { - "group": "Fine-tuning", - "pages": [ - "api-reference/inference-api/fine-tuning/create-fine-tuning-job", - "api-reference/inference-api/fine-tuning/list-fine-tuning-jobs", - "api-reference/inference-api/fine-tuning/retrieve-fine-tuning-job", - "api-reference/inference-api/fine-tuning/list-fine-tuning-events", - "api-reference/inference-api/fine-tuning/list-fine-tuning-checkpoints", - "api-reference/inference-api/fine-tuning/cancel-fine-tuning" - ] - }, - { - "group": "Batch", - "pages": [ - "api-reference/inference-api/batch/create-batch", - "api-reference/inference-api/batch/list-batch", - "api-reference/inference-api/batch/retrieve-batch", - "api-reference/inference-api/batch/cancel-batch" - ] - }, - { - "group": "Files", - "pages": [ - "api-reference/inference-api/files/upload-file", - "api-reference/inference-api/files/list-files", - "api-reference/inference-api/files/retrieve-file", - "api-reference/inference-api/files/retrieve-file-content", - "api-reference/inference-api/files/delete-file" - ] - }, - { - "group": "Assistants", - "pages": [ + }, { - "group": "Assistants", + "group": "Users", "pages": [ - "api-reference/inference-api/assistants-api/assistants/create-assistant", - "api-reference/inference-api/assistants-api/assistants/list-assistants", - "api-reference/inference-api/assistants-api/assistants/retrieve-assistant", - "api-reference/inference-api/assistants-api/assistants/modify-assistant", - "api-reference/inference-api/assistants-api/assistants/delete-assistant" + "api-reference/admin-api/control-plane/users/retrieve-a-user", + "api-reference/admin-api/control-plane/users/retrieve-all-users", + "api-reference/admin-api/control-plane/users/update-a-user", + "api-reference/admin-api/control-plane/users/remove-a-user" ] }, { - "group": "Threads", + "group": "User Invites", "pages": [ - "api-reference/inference-api/assistants-api/threads/create-thread", - "api-reference/inference-api/assistants-api/threads/retrieve-thread", - "api-reference/inference-api/assistants-api/threads/modify-thread", - "api-reference/inference-api/assistants-api/threads/delete-thread" + "api-reference/admin-api/control-plane/user-invites/invite-a-user", + "api-reference/admin-api/control-plane/user-invites/retrieve-an-invite", + "api-reference/admin-api/control-plane/user-invites/retrieve-all-user-invites", + "api-reference/admin-api/control-plane/user-invites/delete-a-user-invite", + "api-reference/admin-api/control-plane/user-invites/resend-a-user-invite" ] }, { - "group": "Messages", + "group": "Workspaces", "pages": [ - "api-reference/inference-api/assistants-api/messages/create-message", - "api-reference/inference-api/assistants-api/messages/list-messages", - "api-reference/inference-api/assistants-api/messages/retrieve-message", - "api-reference/inference-api/assistants-api/messages/modify-message", - "api-reference/inference-api/assistants-api/messages/delete-message" + "api-reference/admin-api/control-plane/workspaces/create-workspace", + "api-reference/admin-api/control-plane/workspaces/retrieve-all-workspaces", + "api-reference/admin-api/control-plane/workspaces/retrieve-a-workspace", + "api-reference/admin-api/control-plane/workspaces/update-workspace", + "api-reference/admin-api/control-plane/workspaces/delete-a-workspace" ] }, { - "group": "Runs", + "group": "Workspace Members", "pages": [ - "api-reference/inference-api/assistants-api/runs/create-run", - "api-reference/inference-api/assistants-api/runs/create-thread-and-run", - "api-reference/inference-api/assistants-api/runs/list-runs", - "api-reference/inference-api/assistants-api/runs/retrieve-run", - "api-reference/inference-api/assistants-api/runs/modify-run", - "api-reference/inference-api/assistants-api/runs/submit-tool-outputs-to-run", - "api-reference/inference-api/assistants-api/runs/cancel-run" + "api-reference/admin-api/control-plane/workspace-members/add-a-workspace-member", + "api-reference/admin-api/control-plane/workspace-members/retrieve-all-workspace-members", + "api-reference/admin-api/control-plane/workspace-members/retrieve-a-workspace-member", + "api-reference/admin-api/control-plane/workspace-members/update-workspace-member", + "api-reference/admin-api/control-plane/workspace-members/remove-workspace-member" ] }, { - "group": "Run Steps", + "group": "Audit Logs", "pages": [ - "api-reference/inference-api/assistants-api/run-steps/list-run-steps", - "api-reference/inference-api/assistants-api/run-steps/retrieve-run-steps" + "api-reference/admin-api/control-plane/audit-logs/list-audit-logs" ] + }, + { + "group": "OpenAPI", + "pages": ["api-reference/admin-api/open-api-specification"] } ] - } - ] - }, - { - "tab": "Admin API", - "groups": [ - { - "group": "API Reference", - "pages": ["api-reference/admin-api/introduction"] - }, - { - "group": "Configs", - "pages": [ - "api-reference/admin-api/control-plane/configs/create-config", - "api-reference/admin-api/control-plane/configs/list-configs", - "api-reference/admin-api/control-plane/configs/retrieve-config", - "api-reference/admin-api/control-plane/configs/update-config", - "api-reference/admin-api/control-plane/configs/delete-config" - ] - }, - { - "group": "Virtual Keys", - "pages": [ - "api-reference/admin-api/control-plane/virtual-keys/create-virtual-key", - "api-reference/admin-api/control-plane/virtual-keys/list-virtual-keys", - "api-reference/admin-api/control-plane/virtual-keys/retrieve-virtual-key", - "api-reference/admin-api/control-plane/virtual-keys/update-virtual-key", - "api-reference/admin-api/control-plane/virtual-keys/delete-virtual-key" - ] }, { - "group": "Prompts", - "pages": [ - "api-reference/admin-api/control-plane/prompts/create-prompt", - "api-reference/admin-api/control-plane/prompts/list-prompts", - "api-reference/admin-api/control-plane/prompts/retrieve-prompt", - "api-reference/admin-api/control-plane/prompts/update-prompt", - "api-reference/admin-api/control-plane/prompts/delete-prompt", - "api-reference/admin-api/control-plane/prompts/publish-prompt", - "api-reference/admin-api/control-plane/prompts/list-prompt-versions", - "api-reference/admin-api/control-plane/prompts/retrieve-prompt-version", - "api-reference/admin-api/control-plane/prompts/update-prompt-version", + "tab": "Cookbook", + "groups": [ { - "group": "Prompt Partials", + "group": "Evals", "pages": [ - "api-reference/admin-api/control-plane/prompts/partials/create-partial", - "api-reference/admin-api/control-plane/prompts/partials/list-partials", - "api-reference/admin-api/control-plane/prompts/partials/retrieve-partial", - "api-reference/admin-api/control-plane/prompts/partials/update-partial", - "api-reference/admin-api/control-plane/prompts/partials/delete-partial", - "api-reference/admin-api/control-plane/prompts/partials/list-partial-versions", - "api-reference/admin-api/control-plane/prompts/partials/publish-partial" + "guides/use-cases/run-batch-evals", + "guides/prompts/llm-as-a-judge" ] }, { - "group": "Prompt Labels", + "group": "Prompt Engineering", "pages": [ - "api-reference/admin-api/control-plane/prompts/labels/create-label", - "api-reference/admin-api/control-plane/prompts/labels/list-labels", - "api-reference/admin-api/control-plane/prompts/labels/retrieve-label", - "api-reference/admin-api/control-plane/prompts/labels/update-label", - "api-reference/admin-api/control-plane/prompts/labels/delete-label" + "guides/prompts", + "guides/prompts/ultimate-ai-sdr", + "guides/prompts/build-a-chatbot-using-portkeys-prompt-templates", + "guides/prompts/llm-as-a-judge", + "guides/prompts/llama-prompts" ] }, { - "group": "Prompt Collections", + "group": "Whitepapers", "pages": [ - "api-reference/admin-api/control-plane/prompts/collections/create-collection", - "api-reference/admin-api/control-plane/prompts/collections/list-collections", - "api-reference/admin-api/control-plane/prompts/collections/retrieve-collection", - "api-reference/admin-api/control-plane/prompts/collections/update-collection", - "api-reference/admin-api/control-plane/prompts/collections/delete-collection" + { + "group": "Optimizing LLM Costs", + "pages": [ + "guides/whitepapers/optimizing-llm-costs/executive-summary", + "guides/whitepapers/optimizing-llm-costs/introduction", + "guides/whitepapers/optimizing-llm-costs/llm-cost-drivers", + "guides/whitepapers/optimizing-llm-costs/frugalgpt-techniques", + "guides/whitepapers/optimizing-llm-costs/advanced-strategies", + "guides/whitepapers/optimizing-llm-costs/architectural-considerations", + "guides/whitepapers/optimizing-llm-costs/operational-best-practices", + "guides/whitepapers/optimizing-llm-costs/cost-effective-development", + "guides/whitepapers/optimizing-llm-costs/user-education", + "guides/whitepapers/optimizing-llm-costs/future-trends", + "guides/whitepapers/optimizing-llm-costs/conclusion-and-key-takeaways" + ] + } ] - } - ] - }, - { - "group": "API Keys", - "pages": [ - "api-reference/admin-api/control-plane/api-keys/update-api-key", - "api-reference/admin-api/control-plane/api-keys/create-api-key", - "api-reference/admin-api/control-plane/api-keys/delete-an-api-key", - "api-reference/admin-api/control-plane/api-keys/retrieve-an-api-key", - "api-reference/admin-api/control-plane/api-keys/list-api-keys" - ] - }, - { - "group": "Analytics [BETA]", - "pages": [ + }, { - "group": "Summary", + "group": "Getting Started", "pages": [ - "api-reference/admin-api/control-plane/analytics/summary/get-all-cache-data" + "guides/getting-started", + "guides/getting-started/a-b-test-prompts-and-models", + "guides/getting-started/tackling-rate-limiting", + "guides/getting-started/function-calling", + "guides/getting-started/image-generation", + "guides/getting-started/getting-started-with-ai-gateway", + "guides/getting-started/llama-3-on-groq", + "guides/getting-started/return-repeat-requests-from-cache", + "guides/getting-started/trigger-automatic-retries-on-llm-failures", + "guides/getting-started/101-on-portkey-s-gateway-configs" ] }, { - "group": "Groups Paginated Data", + "group": "Integrations", "pages": [ - "api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-metadata-grouped-data", - "api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-model-grouped-data", - "api-reference/admin-api/control-plane/analytics/groups-paginated-data/get-user-grouped-data" + "guides/integrations", + "guides/integrations/llama-3-on-portkey-+-together-ai", + "guides/integrations/introduction-to-gpt-4o", + "guides/integrations/anyscale", + "guides/integrations/mistral", + "guides/integrations/vercel-ai", + "guides/integrations/deepinfra", + "guides/integrations/groq", + "guides/integrations/langchain", + "guides/integrations/mixtral-8x22b", + "guides/integrations/segmind" ] }, { - "group": "Graphs - Time Series Data", + "group": "Use Cases", "pages": [ - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cache-hit-latency-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cache-hit-rate-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-cost-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-error-rate-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-errors-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-per-ai-models-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-feedback-score-distribution-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-latency-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-requests-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-requests-per-user-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-rescued-requests-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-status-code-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-tokens-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-unique-status-code-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-users-data", - "api-reference/admin-api/control-plane/analytics/graphs-time-series-data/get-weighted-feedback-data" - ] - } - ] - }, - { - "group": "Users", - "pages": [ - "api-reference/admin-api/control-plane/users/retrieve-a-user", - "api-reference/admin-api/control-plane/users/retrieve-all-users", - "api-reference/admin-api/control-plane/users/update-a-user", - "api-reference/admin-api/control-plane/users/remove-a-user" - ] - }, - { - "group": "User Invites", - "pages": [ - "api-reference/admin-api/control-plane/user-invites/invite-a-user", - "api-reference/admin-api/control-plane/user-invites/retrieve-an-invite", - "api-reference/admin-api/control-plane/user-invites/retrieve-all-user-invites", - "api-reference/admin-api/control-plane/user-invites/delete-a-user-invite", - "api-reference/admin-api/control-plane/user-invites/resend-a-user-invite" - ] - }, - { - "group": "Workspaces", - "pages": [ - "api-reference/admin-api/control-plane/workspaces/create-workspace", - "api-reference/admin-api/control-plane/workspaces/retrieve-all-workspaces", - "api-reference/admin-api/control-plane/workspaces/retrieve-a-workspace", - "api-reference/admin-api/control-plane/workspaces/update-workspace", - "api-reference/admin-api/control-plane/workspaces/delete-a-workspace" - ] - }, - { - "group": "Workspace Members", - "pages": [ - "api-reference/admin-api/control-plane/workspace-members/add-a-workspace-member", - "api-reference/admin-api/control-plane/workspace-members/retrieve-all-workspace-members", - "api-reference/admin-api/control-plane/workspace-members/retrieve-a-workspace-member", - "api-reference/admin-api/control-plane/workspace-members/update-workspace-member", - "api-reference/admin-api/control-plane/workspace-members/remove-workspace-member" - ] - }, - { - "group": "Audit Logs", - "pages": [ - "api-reference/admin-api/control-plane/audit-logs/list-audit-logs" - ] - }, - { - "group": "OpenAPI", - "pages": ["api-reference/admin-api/open-api-specification"] - } - ] - }, - { - "tab": "Cookbook", - "groups": [ - { - "group": "Evals", - "pages": [ - "guides/use-cases/run-batch-evals", - "guides/prompts/llm-as-a-judge" - ] - }, - { - "group": "Prompt Engineering", - "pages": [ - "guides/prompts", - "guides/prompts/ultimate-ai-sdr", - "guides/prompts/build-a-chatbot-using-portkeys-prompt-templates", - "guides/prompts/llm-as-a-judge", - "guides/prompts/llama-prompts" - ] - }, - { - "group": "Whitepapers", - "pages": [ - { - "group": "Optimizing LLM Costs", - "pages": [ - "guides/whitepapers/optimizing-llm-costs/executive-summary", - "guides/whitepapers/optimizing-llm-costs/introduction", - "guides/whitepapers/optimizing-llm-costs/llm-cost-drivers", - "guides/whitepapers/optimizing-llm-costs/frugalgpt-techniques", - "guides/whitepapers/optimizing-llm-costs/advanced-strategies", - "guides/whitepapers/optimizing-llm-costs/architectural-considerations", - "guides/whitepapers/optimizing-llm-costs/operational-best-practices", - "guides/whitepapers/optimizing-llm-costs/cost-effective-development", - "guides/whitepapers/optimizing-llm-costs/user-education", - "guides/whitepapers/optimizing-llm-costs/future-trends", - "guides/whitepapers/optimizing-llm-costs/conclusion-and-key-takeaways" + "guides/use-cases", + "guides/use-cases/librechat-web-search", + "guides/use-cases/few-shot-prompting", + "guides/use-cases/enforcing-json-schema-with-anyscale-and-together", + "guides/use-cases/emotions-with-gpt-4o", + "guides/use-cases/build-an-article-suggestion-app-with-supabase-pgvector-and-portkey", + "guides/use-cases/setting-up-resilient-load-balancers-with-failure-mitigating-fallbacks", + "guides/use-cases/run-portkey-on-prompts-from-langchain-hub", + "guides/use-cases/smart-fallback-with-model-optimized-prompts", + "guides/use-cases/how-to-use-openai-sdk-with-portkey-prompt-templates", + "guides/use-cases/setup-openai-greater-than-azure-openai-fallback", + "guides/use-cases/fallback-from-sdxl-to-dall-e-3", + "guides/use-cases/comparing-top10-lmsys-models-with-portkey", + "guides/use-cases/track-costs-using-metadata", + "guides/use-cases/deepseek-r1", + "guides/use-cases/openai-computer-use" ] } ] }, { - "group": "Getting Started", - "pages": [ - "guides/getting-started", - "guides/getting-started/a-b-test-prompts-and-models", - "guides/getting-started/tackling-rate-limiting", - "guides/getting-started/function-calling", - "guides/getting-started/image-generation", - "guides/getting-started/getting-started-with-ai-gateway", - "guides/getting-started/llama-3-on-groq", - "guides/getting-started/return-repeat-requests-from-cache", - "guides/getting-started/trigger-automatic-retries-on-llm-failures", - "guides/getting-started/101-on-portkey-s-gateway-configs" - ] - }, - { - "group": "Integrations", - "pages": [ - "guides/integrations", - "guides/integrations/llama-3-on-portkey-+-together-ai", - "guides/integrations/introduction-to-gpt-4o", - "guides/integrations/anyscale", - "guides/integrations/mistral", - "guides/integrations/vercel-ai", - "guides/integrations/deepinfra", - "guides/integrations/groq", - "guides/integrations/langchain", - "guides/integrations/mixtral-8x22b", - "guides/integrations/segmind" - ] - }, - { - "group": "Use Cases", - "pages": [ - "guides/use-cases", - "guides/use-cases/librechat-web-search", - "guides/use-cases/few-shot-prompting", - "guides/use-cases/enforcing-json-schema-with-anyscale-and-together", - "guides/use-cases/emotions-with-gpt-4o", - "guides/use-cases/build-an-article-suggestion-app-with-supabase-pgvector-and-portkey", - "guides/use-cases/setting-up-resilient-load-balancers-with-failure-mitigating-fallbacks", - "guides/use-cases/run-portkey-on-prompts-from-langchain-hub", - "guides/use-cases/smart-fallback-with-model-optimized-prompts", - "guides/use-cases/how-to-use-openai-sdk-with-portkey-prompt-templates", - "guides/use-cases/setup-openai-greater-than-azure-openai-fallback", - "guides/use-cases/fallback-from-sdxl-to-dall-e-3", - "guides/use-cases/comparing-top10-lmsys-models-with-portkey", - "guides/use-cases/track-costs-using-metadata", - "guides/use-cases/deepseek-r1", - "guides/use-cases/openai-computer-use" - ] - } - ] - }, - { - "tab": "Changelog", - "groups": [ - { - "group": "Monthly Summary", - "pages": [ + "tab": "Changelog", + "groups": [ { - "group": "2025", + "group": "Monthly Summary", "pages": [ - "changelog/2025/may", - "changelog/2025/apr", - "changelog/2025/mar", - "changelog/2025/feb", - "changelog/2025/jan" + { + "group": "2025", + "pages": [ + "changelog/2025/may", + "changelog/2025/apr", + "changelog/2025/mar", + "changelog/2025/feb", + "changelog/2025/jan" + ] + }, + { + "group": "2024", + "pages": [ + "changelog/2024/dec", + "changelog/2024/nov", + "changelog/2024/oct" + ] + } ] }, { - "group": "2024", + "group": "Enterprise Releases", + "pages": ["changelog/enterprise", "changelog/helm-chart"] + }, + { + "group": "Product Releases", + "pages": ["changelog/product"] + }, + { + "group": "SDK Releases", "pages": [ - "changelog/2024/dec", - "changelog/2024/nov", - "changelog/2024/oct" + "changelog/node-sdk-changelog", + "changelog/python-sdk-changelog" ] } ] - }, - { - "group": "Enterprise Releases", - "pages": ["changelog/enterprise", "changelog/helm-chart"] - }, - { - "group": "Product Releases", - "pages": ["changelog/product"] - }, - { - "group": "SDK Releases", - "pages": [ - "changelog/node-sdk-changelog", - "changelog/python-sdk-changelog" - ] } ] } diff --git a/product/ai-gateway/virtual-keys.mdx b/product/ai-gateway/virtual-keys.mdx index 7cf3a6d5..4f3ab853 100644 --- a/product/ai-gateway/virtual-keys.mdx +++ b/product/ai-gateway/virtual-keys.mdx @@ -1,6 +1,7 @@ --- title: "Virtual Keys" description: "Portkey's virtual key system allows you to securely store your LLM API keys in our vault, utilizing a unique virtual identifier to streamline API key management." +tag: "Deprecated" --- diff --git a/product/integrations.mdx b/product/integrations.mdx index 0ac96ffe..83201dcf 100644 --- a/product/integrations.mdx +++ b/product/integrations.mdx @@ -1,52 +1,56 @@ --- -title: Integrations +title: LLM Integrations description: A step-by-step guide for organization admins to set up their first integration. --- -# **Org Admin Quickstart: Setting Up Your First Model Catalog Integration** +The **Integrations** page is the central command center for Organization Admins. It's where you securely manage all third-party LLM provider credentials and govern their use across all workspaces from a single, unified dashboard. -As an Organization Admin, the Model Catalog gives you the power to centrally manage, provision, and govern all AI models used across your company. This guide will walk you through creating your first centralized integration. +This "create once, provision many" model saves significant time, reduces configuration errors, and gives you complete oversight of your AI stack. -**Prerequisite:** The Model Catalog feature has been enabled for your organization by the Portkey team. +### **Understanding the Integrations Dashboard** -### **Navigating to the Integrations Hub** +The Integrations page is organized into three tabs, each serving a distinct purpose: -1. Click on your organization name in the bottom-left corner of the sidebar. -2. In the menu that appears, select **Integrations**. This is your new central dashboard for all provider connections. +* **`All`**: This is a comprehensive list of all 50+ providers Portkey supports. This is your starting point for connecting a new provider to your organization. +* **`Connected`**: This tab lists all the integrations that you have personally connected at the organization level. It's your primary view for managing your centrally-governed providers. +* **`Workspace-Created`**: This tab gives you complete visibility and governance over any integrations created *by Workspace Admins* for their specific workspaces. It ensures that even with delegated control, you maintain a full audit trail and can manage these instances if needed. - +--- + +### **Creating and Provisioning a New Integration** + +This guide walks you through connecting a new provider and making it available to your workspaces. -### **Step 1: Connect a New Provider Integration** +#### **Step 1: Connect the Provider** -This step is similar to creating a Virtual Key, but it's happening at the organization level. + +If you are an existing Portkey user, this step is similar to creating a Virtual Key, but it's happening at the organization level. + -1. From the **Integrations** page, find the provider you want to connect (e.g., OpenAI, Azure OpenAI, AWS Bedrock) and click **Connect**. +1. From the **`All`** tab, find the provider you want to connect (e.g., OpenAI, Azure OpenAI, AWS Bedrock) and click **Connect**. 2. Fill in the details: * **Integration Name:** A friendly name for you to identify this connection (e.g., "Azure Production - US East"). * **Slug:** A unique, URL-friendly identifier. This will be used by developers to call models (e.g., `azure-prod-useast`). * **Credentials:** Securely enter your API keys or other authentication details. These are encrypted and will not be visible after saving. 3. Click **Next**. -### **Step 2: Provision the Integration to Workspaces** +#### **Step 2: Provision to Workspaces** Here, you decide which teams get access to this provider and under what conditions. 1. You will see a list of all workspaces within your organization. 2. Use the toggle next to a workspace name to **enable or disable** access. 3. For each enabled workspace, you can optionally click **Edit Budget & Rate Limits** to set specific spending caps or request limits that apply *only to that workspace* for this integration. -4. **(Optional) For New Workspaces:** Toggle on **"Automatically provision this integration for new workspaces"** to ensure any future teams automatically get access with a default budget/rate limit you define. +4. **(Optional) For Provisioning to New Workspaces:** Toggle on **"Automatically provision this integration for new workspaces"** to ensure any future teams automatically get access with a default budget/rate limit you define. 5. Click **Next**. - +#### **Step 3: Provision Specific Models** -### **Step 3: Provision Specific Models** - -This is where you enforce model governance. +This is where you enforce model governance and control costs. 1. You will see a list of all models available from the provider you're connecting. -2. By default, all models may be selected. You can **Clear all** and then select only the models you wish to approve for use. -3. **(Optional) For Dynamic Models:** If you're using a provider like Fireworks AI with many community models, you can toggle on **"Automatically enable new models"**. This is useful, but for providers like OpenAI or Azure, we recommend an explicit allow-list for better cost control. +2. You can **Clear all** and then select only the models you wish to approve for use. +3. **(Optional) For Dynamic Models:** If you're using a provider like Fireworks AI with many community models, you can toggle on **"Automatically enable new models"**. For providers like OpenAI or Azure, we recommend an explicit allow-list for better cost control. 4. Click **Create Integration**. -**That's it!** You have successfully created a centrally managed integration. The workspaces you provisioned will now see this as an available "AI Provider" in their Model Catalog, with access only to the models you specified and constrained by the budgets you set. You can now repeat this process for all your providers. - +**That's it!** You have successfully created and provisioned a centrally managed integration. It will now appear in your **`Connected`** tab. The workspaces you provisioned will see this as an available "AI Provider" in their Model Catalog, with access only to the models you specified and constrained by the budgets you set. \ No newline at end of file diff --git a/product/integrations/agents.mdx b/product/integrations/agents.mdx new file mode 100644 index 00000000..94931f39 --- /dev/null +++ b/product/integrations/agents.mdx @@ -0,0 +1,4 @@ +--- +title: Agents +url: /integrations/agents +--- \ No newline at end of file diff --git a/product/integrations/ai-apps.mdx b/product/integrations/ai-apps.mdx new file mode 100644 index 00000000..bdfc568c --- /dev/null +++ b/product/integrations/ai-apps.mdx @@ -0,0 +1,4 @@ +--- +title: AI Apps +url: /integrations/ai-apps +--- \ No newline at end of file diff --git a/product/integrations/cloud.mdx b/product/integrations/cloud.mdx new file mode 100644 index 00000000..9236d6c2 --- /dev/null +++ b/product/integrations/cloud.mdx @@ -0,0 +1,4 @@ +--- +title: Cloud Providers +url: /integrations/cloud +--- \ No newline at end of file diff --git a/product/integrations/guardrails.mdx b/product/integrations/guardrails.mdx new file mode 100644 index 00000000..ec1585c9 --- /dev/null +++ b/product/integrations/guardrails.mdx @@ -0,0 +1,4 @@ +--- +title: Guardrails +url: /product/guardrails/list-of-guardrail-checks +--- diff --git a/product/integrations/libraries.mdx b/product/integrations/libraries.mdx new file mode 100644 index 00000000..0db8adf8 --- /dev/null +++ b/product/integrations/libraries.mdx @@ -0,0 +1,4 @@ +--- +title: Libraries +url: /integrations/libraries +--- \ No newline at end of file diff --git a/product/integrations/plugins.mdx b/product/integrations/plugins.mdx new file mode 100644 index 00000000..26ca513d --- /dev/null +++ b/product/integrations/plugins.mdx @@ -0,0 +1,4 @@ +--- +title: Gateway Plugins +url: /integrations/plugins +--- \ No newline at end of file diff --git a/product/integrations/tracing.mdx b/product/integrations/tracing.mdx new file mode 100644 index 00000000..efae6925 --- /dev/null +++ b/product/integrations/tracing.mdx @@ -0,0 +1,4 @@ +--- +title: Tracing +url: /integrations/tracing +--- \ No newline at end of file diff --git a/product/model-catalog.mdx b/product/model-catalog.mdx index 5c96ec3c..f4353959 100644 --- a/product/model-catalog.mdx +++ b/product/model-catalog.mdx @@ -1,59 +1,58 @@ --- title: Model Catalog -description: This guide is focused on the end-user (the developer) and explains how to take advantage of the new, simplified workflow. +description: Explore and query every AI model available to your workspace, with instant code snippets for all supported providers. --- -The new Model Catalog makes discovering and using AI models in Portkey easier and more flexible than ever before. This guide shows you how to find available models and how to call them in your code. +The **Model Catalog** is the evolution of Virtual Keys, providing a centralized and powerful way to manage, discover, and use AI models within your workspace. It consists of two main sections: **AI Providers**, where you manage your connections, and **Models**, where you explore what you can use. -### **The Model Garden: Your Personal AI Model Gallery** +### **How it Works: Inheritance from the Organization** -Inside your workspace, the "Virtual Keys" item on the sidebar has been replaced by the **Model Catalog**. Clicking this takes you to two tabs: "AI Providers" and "Models". +The most significant change with the Model Catalog is the concept of inheritance. Think of it this way: -The **Models** tab is your new "Model Garden." It's a central gallery that lists every single model you have been given access to by your admins, across all providers (OpenAI, Anthropic, Google, etc.). +1. Your **Organization Admin** creates a master **Integration** at the company level (e.g., for "Azure Production"). They add the credentials and can set default budgets, rate limits, and an allow-list of approved models for that integration. +2. When they provision this integration to your workspace, a corresponding **AI Provider** is automatically created in your Model Catalog. +3. This new AI Provider in your workspace *inherits* all the settings from the organization-level integration, including its credentials, model access, and spending limits. -- **Discover Models:** Browse or search for any model available to you. -- **See Providers:** Click on a model to see which provider(s) you can use to access it. For example, `claude-3-opus` might be available via both AWS Bedrock and Anthropic direct. -- **Get Code Snippets:** The best part! Click a model, select your provider and language, and Portkey will generate the exact code snippet you need to start making calls. +This "create once, provision many" approach provides central governance while giving workspaces the flexibility they need. - - -### **The New Way to Call Models: Simple and Powerful** +--- -With the Model Catalog, you no longer need to rely on your admin to bind a specific virtual key to your API key. You can now choose your provider and model directly in your request. +### **The Model Catalog Experience by Role** -The `model` parameter now accepts a new format: `@{provider_slug}/{model_slug}` +Your experience with the Model Catalog will differ based on your role within the Portkey organization. -- `provider_slug`: The unique slug for the provider (e.g., `openai-prod`). You can find this in your Model Garden. -- `model_slug`: The name of the model you want to use (e.g., `gpt-4o`). +#### **For Workspace Members (Developers): Discover and Build** -#### **Example: Switching Between Providers on the Fly** +As a developer, your experience is simplified and streamlined. You primarily interact with the **Models** tab, which acts as your personal "Model Garden." -Imagine your admin has given you access to OpenAI via a provider with the slug `openai-main` and to Anthropic on Bedrock via `bedrock-us-east-1`. With a single Portkey API key, you can do this: +- **Discover Models:** The "Models" tab is a complete gallery of every single model you have been given access to by your admins. +- **Get Code Snippets:** Click on any model, and Portkey will generate the exact code snippet you need to start making calls, with the correct provider and model slugs already included. +- **Simplified API Calls:** You can now call any model directly using the `model` parameter, formatted as `@{provider_slug}/{model_slug}`. This lets you switch between providers and models on the fly with a single Portkey API key. ```python -# main.py -from portkey import Portkey - -# Your single Portkey API Key is all you need -client = Portkey() - -# Make a call to GPT-4o -response_openai = client.chat.completions.create( - model="@openai-main/gpt-4o", - messages=[{"role": "user", "content": "Explain the theory of relativity in simple terms."}] +# Switch between a model on OpenAI and one on Bedrock seamlessly +client.chat.completions.create( + model="@openai-prod/gpt-4o", + messages=[...] ) -print(response_openai.choices[0].message.content) -# In the same script, switch to Claude 3 Sonnet -response_claude = client.chat.completions.create( - model="@bedrock-us-east-1/anthropic.claude-3-sonnet-20240229-v1:0", - messages=[{"role": "user", "content": "Write a short poem about coding."}] +client.chat.completions.create( + model="@bedrock-us/claude-3-sonnet-v1", + messages=[...] ) -print(response_claude.choices[0].message.content) ``` -### **What About the Old Way?** +#### **For Workspace Admins: Manage and Customize** + +As a Workspace Admin, you have more control over the providers within your workspace via the **AI Providers** tab. + +You will see a list of providers that have been inherited from the organization. From here, you have two primary options when you click **Create Provider**: + +1. **Inherit from an Org Integration:** You can create *additional* providers that are based on an existing org-level integration. This is useful for subdividing access within your team. For example, if your workspace has a $1000 budget on the main "Azure Prod" integration, you could create a new provider from it named "azure-prod-experimental" and give it a stricter $100 budget for a specific project. +2. **Create a New Workspace-Exclusive Integration:** If your Org Admin has enabled the permission, you can create a brand new integration from scratch. This provider is exclusive to your workspace and functions just like the old Virtual Keys did. + +#### **For Organization Admins: A View into Workspaces** -**It still works!** If you are using code that passes a `virtual_key` in the header or in a Portkey Config, it will continue to function without any changes. +While Org Admins primarily work in the main **[Integrations](/product/integrations)** dashboard, the Model Catalog provides a crucial feedback loop: -The new `model` parameter format is an enhancement for flexibility and ease of use, allowing you to access the full power of your workspace's Model Garden with minimal friction. \ No newline at end of file +When a Workspace Admin creates a new, workspace-exclusive integration (option #2 above), you gain full visibility. This new integration will automatically appear on your main Integrations page under the **"Workspace-Created"** tab, ensuring you always have a complete audit trail of all provider credentials being used across the organization. \ No newline at end of file