Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions aigw/api-reference/inference-api/config-object.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -735,13 +735,13 @@ You can find more examples of schemas [below](/aigw/api-reference/inference-api/
| Example | Description |
|---------|-------------|
| [Single Provider](#single-provider-with-provider-slug) | Basic setup with provider slug (recommended) |
| [With Hyperparameters](#provider-slug-with-model--hyperparameters) | Override model and parameters |
| [With Hyperparameters](#provider-slug-with-model-&-hyperparameters) | Override model and parameters |
| [Cache + Retry](#provider-slug-with-cache-and-retry) | Enable caching and retry logic |
| [Load Balancing](#load-balancing-with-provider-slugs) | Distribute traffic across providers |
| [Fallback](#fallback-across-providers) | Automatic failover between providers |
| [Combined Strategies](#load-balancing-and-fallback-combination) | Nested load balancing with fallback |
| [Passthrough Target](#passthrough-target) | Defer provider resolution to the request |
| [Legacy: API Key](#legacy-single-provider-with-api-key) | Direct API key usage |
| [Legacy: API Key](#legacy-single-provider-with-virtual-key) | Direct API key usage |
| [Legacy: Virtual Key](#legacy-single-provider-with-virtual-key) | Virtual key usage |

---
Expand Down
2 changes: 1 addition & 1 deletion aigw/api-reference/inference-api/headers.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Authenticate your requests with your AI Gateway API key, passed as `Bearer $PORT
Environment variable: `PORTKEY_API_KEY`

<Note>
The `x-portkey-api-key` header remains active and continues to authenticate requests. `Authorization` is the standard way to authenticate into the gateway; use `x-portkey-api-key` when `Authorization` is already carrying provider credentials, as in [Provider Slug + Auth](#1-provider-slug-auth) below.
The `x-portkey-api-key` header remains active and continues to authenticate requests. `Authorization` is the standard way to authenticate into the gateway; use `x-portkey-api-key` when `Authorization` is already carrying provider credentials, as in [Provider Slug + Auth](#1-provider-slug-+-auth) below.
</Note>
<Accordion title="Example">
<CodeGroup>
Expand Down
2 changes: 1 addition & 1 deletion aigw/help-center/mcp-gateway-troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ MCP Gateway authenticates in two places: your client → Prisma AIRS AI Gateway
| `401` | Missing/expired token, or the MCP server needs you to sign in | Re-authenticate; if prompted, complete the server's sign-in |
| `403` | You're authenticated but not allowed | Wrong workspace/server in the URL, or you don't have access to that server |
| `404` | Server not found | The slug in your URL is wrong, or the server isn't registered in this workspace |
| `500` "Unable to verify user access" | The gateway couldn't confirm your access | See [API key type](#can-t-connect-or-access-denied) below |
| `500` "Unable to verify user access" | The gateway couldn't confirm your access | See [API key type](#can’t-connect-or-access-denied) below |

---

Expand Down
2 changes: 1 addition & 1 deletion aigw/integrations/llms/azure-openai/batches.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ This is the most efficient way to
<Info>
The AI Gateway supports **two modes** on Azure OpenAI:
* **[Provider Batch API](#using-azure-openai-batch-api-through-the-ai-gateway)** (cheapest, completion_window: `24h`, `48h`, etc.)
* **[AI Gateway Batch API](/aigw/product/ai-gateway/batches#portkey-batch-api-mode)** (fast, provider-agnostic, completion_window: `immediate`)
* **[AI Gateway Batch API](/aigw/product/ai-gateway/batches#provider-batch-api-mode)** (fast, provider-agnostic, completion_window: `immediate`)
</Info>

## Using Azure OpenAI Batch API through the AI Gateway
Expand Down
2 changes: 1 addition & 1 deletion aigw/integrations/llms/bedrock/aws-bedrock.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ If you're using [AWS Security Token Service](https://docs.aws.amazon.com/STS/lat

#### Not using Bedrock Provider from Model Catalog?

[Check out this example on how you can directly use your AWS details to make a Bedrock request through the AI Gateway.](/aigw/integrations/llms/bedrock/aws-bedrock#making-requests-without-using-portkey%E2%80%99s-model-catalog)
[Check out this example on how you can directly use your AWS details to make a Bedrock request through the AI Gateway.](/aigw/integrations/llms/bedrock/aws-bedrock#making-requests-without-using-the-ai-gateway’s-model-catalog)

### **3\. Invoke Chat Completions with AWS bedrock**

Expand Down
2 changes: 1 addition & 1 deletion aigw/integrations/llms/bedrock/batches.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ This is the most efficient way to
<Info>
The AI Gateway supports **two modes** on Bedrock:
* **[Provider Batch API](#using-bedrock-batch-api-through-the-ai-gateway)** (cheapest, completion_window: `24h`, `48h`, etc.)
* **[AI Gateway Batch API ⭐️](/aigw/product/ai-gateway/batches#portkey-batch-api-mode)** (fast, provider-agnostic, completion_window: `immediate`)
* **[AI Gateway Batch API ⭐️](/aigw/product/ai-gateway/batches#provider-batch-api-mode)** (fast, provider-agnostic, completion_window: `immediate`)
</Info>

## Before You Start
Expand Down
2 changes: 1 addition & 1 deletion aigw/integrations/llms/vertex-ai/batches.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ With Prisma AIRS AI Gateway, you can perform batch inference operations with Ver
<Info>
The AI Gateway supports **two modes** on Vertex:
* **[Provider Batch API](#using-vertex-batch-api-through-the-ai-gateway)** (cheapest, completion_window: `24h`, `48h`, etc.)
* **[AI Gateway Batch API](/aigw/product/ai-gateway/batches#portkey-batch-api-mode)** (fast, provider-agnostic, completion_window: `immediate`)
* **[AI Gateway Batch API](/aigw/product/ai-gateway/batches#provider-batch-api-mode)** (fast, provider-agnostic, completion_window: `immediate`)
</Info>

## Using Vertex Batch API through the AI Gateway
Expand Down
2 changes: 1 addition & 1 deletion aigw/product/enterprise-offering/security.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ These encryption standards are part of our commitment to maintaining secure data

Our access control measures are designed with granularity to offer precise control over who can see and manage data.

We provide [Role-Based Access Control (RBAC)](/aigw/product/enterprise-offering/access-control-management#id-2.-fine-grained-user-roles-and-permissions), allowing for stringent governance suited to complex organisational needs.
We provide [Role-Based Access Control (RBAC)](/aigw/product/enterprise-offering/access-control-management#2-fine-grained-user-roles-and-permissions), allowing for stringent governance suited to complex organisational needs.

This system is pivotal for enforcing security policies and ensuring that only authorized personnel have access to sensitive operations and data.

Expand Down
4 changes: 2 additions & 2 deletions api-reference/inference-api/config-object.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -737,13 +737,13 @@ You can find more examples of schemas [below](/api-reference/inference-api/confi
| Example | Description |
|---------|-------------|
| [Single Provider](#single-provider-with-provider-slug) | Basic setup with provider slug (recommended) |
| [With Hyperparameters](#provider-slug-with-model--hyperparameters) | Override model and parameters |
| [With Hyperparameters](#provider-slug-with-model-&-hyperparameters) | Override model and parameters |
| [Cache + Retry](#provider-slug-with-cache-and-retry) | Enable caching and retry logic |
| [Load Balancing](#load-balancing-with-provider-slugs) | Distribute traffic across providers |
| [Fallback](#fallback-across-providers) | Automatic failover between providers |
| [Combined Strategies](#load-balancing-and-fallback-combination) | Nested load balancing with fallback |
| [Passthrough Target](#passthrough-target) | Defer provider resolution to the request |
| [Legacy: API Key](#legacy-single-provider-with-api-key) | Direct API key usage |
| [Legacy: API Key](#legacy-single-provider-with-virtual-key) | Direct API key usage |
| [Legacy: Virtual Key](#legacy-single-provider-with-virtual-key) | Virtual key usage |

---
Expand Down
8 changes: 4 additions & 4 deletions changelog/enterprise.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -1279,7 +1279,7 @@ New `x-portkey-sensitive-headers` header (SDK aliases: `sensitive_headers` / `se

`reasoning_effort` (`minimal` / `low` / `medium` / `high` / `none`) now works for Bedrock Claude reasoning models — mapped to adaptive thinking on Claude 4.6, and to `thinking.budget_tokens` on earlier reasoning models.

[Bedrock `reasoning_effort` Documentation](/integrations/llms/bedrock/aws-bedrock#using-reasoning-effort-parameter)
[Bedrock `reasoning_effort` Documentation](/integrations/llms/bedrock/aws-bedrock#using-reasoning_effort-parameter)

### Agent Gateway (Preview)

Expand Down Expand Up @@ -1706,7 +1706,7 @@ Added support for Databricks Model Serving as a new provider with support for ch

Together AI now supports reasoning/thinking models with `reasoning_effort` parameter and `content_blocks` in the response. When `strictOpenAiCompliance` is set to `false`, the response includes structured `content_blocks` with both thinking content and the final text response. Both streaming and non-streaming modes are supported.

[Together AI Documentation](/integrations/llms/together-ai#reasoning--thinking-support)
[Together AI Documentation](/integrations/llms/together-ai#reasoning-/-thinking-support)

### Fixes and Improvements
- **Unified Messages & Responses API**: Fixed issues when a request config had a combination of native and non-native providers (e.g., load balancing across Anthropic and OpenAI). The adapter decision is now made per-provider, ensuring correct behavior for mixed configs.
Expand Down Expand Up @@ -3158,7 +3158,7 @@ We are redacting this release and will be releasing a patch with out Workspace B
- Updated the unified API signature for Extended thinking which was introduced in v1.10.12 to ensure that OpenAI compliant field of the response remain untouched regardless of strict_open_ai_compliance flag.
- More Details:
- [Anthropic](/integrations/llms/anthropic#extended-thinking-reasoning-models)
- [AWS Bedrock](/integrations/llms/bedrock/aws-bedrock#extended-thinking-reasoning-models)
- [AWS Bedrock](/integrations/llms/bedrock/aws-bedrock#extended-thinking-reasoning-models-beta)
- [VertexAI](/integrations/llms/vertex-ai#extended-thinking-reasoning-models)

### Unified Batches API Improvements
Expand Down Expand Up @@ -3210,7 +3210,7 @@ We are redacting this release and will be releasing a patch with out Workspace B
- Introduced a unified API signature to support single-turn and multi-turn conversations with Anthropic Extended Reasoning across Anthropic, AWS Bedrock and VertexAI.
- More Details:
- [Anthropic](/integrations/llms/anthropic#extended-thinking-reasoning-models)
- [AWS Bedrock](/integrations/llms/bedrock/aws-bedrock#extended-thinking-reasoning-models)
- [AWS Bedrock](/integrations/llms/bedrock/aws-bedrock#extended-thinking-reasoning-models-beta)
- [VertexAI](/integrations/llms/vertex-ai#extended-thinking-reasoning-models)

### Prometheus Metric Updates
Expand Down
2 changes: 1 addition & 1 deletion guides/use-cases/few-shot-prompting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ In this configuration, `{{few_shot_examples}}` is a placeholder for the few-shot
<img src="/images/guides/use-case-1.png"/>
</Frame>

1. Click on it and paste the [raw prompt code from above](/guides/use-cases/few-shot-prompting#this-is-how-our-raw-prompt-would-look). And that's it! You have your **dynamically updatable** few shot prompt template ready to deploy.
1. Click on it and paste the [raw prompt code from above](/guides/use-cases/few-shot-prompting#this-is-how-our-raw-prompt-looks). And that's it! You have your **dynamically updatable** few shot prompt template ready to deploy.

## Deploying the Prompt with Portkey

Expand Down
2 changes: 1 addition & 1 deletion help-center/mcp-gateway-troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ MCP Gateway authenticates in two places: your client → Portkey (using your API
| `401` | Missing/expired token, or the MCP server needs you to sign in | Re-authenticate; if prompted, complete the server's sign-in |
| `403` | You're authenticated but not allowed | Wrong workspace/server in the URL, or you don't have access to that server |
| `404` | Server not found | The slug in your URL is wrong, or the server isn't registered in this workspace |
| `500` "Unable to verify user access" | The gateway couldn't confirm your access | See [API key type](#can-t-connect-or-access-denied) below |
| `500` "Unable to verify user access" | The gateway couldn't confirm your access | See [API key type](#can’t-connect-or-access-denied) below |

---

Expand Down
4 changes: 2 additions & 2 deletions integrations/libraries/android-studio.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: 'Add observability, governance, and reliability to Android Studio w
This guide shows how to add Portkey as a **Third-Party Remote Provider** in Android Studio in a few minutes.

<Note>
For enterprise deployments across teams, see [Enterprise Governance](#3-enterprise-governance).
For enterprise deployments across teams, see [Enterprise Governance](#3-set-up-enterprise-governance).
</Note>

## 1. Setup
Expand Down Expand Up @@ -80,7 +80,7 @@ After adding Portkey as a provider:
The models shown are the ones you added in Portkey (e.g. `@openai-prod/gpt-4o`, `@anthropic-prod/claude-3-5-sonnet-20241022`). All traffic is routed through Portkey automatically.

<Note>
**Fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and use the config’s virtual model in Android Studio. See [Enterprise Governance](#3-enterprise-governance) for examples.
**Fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and use the config’s virtual model in Android Studio. See [Enterprise Governance](#3-set-up-enterprise-governance) for examples.
</Note>

import AdvancedFeatures from '/snippets/portkey-advanced-features.mdx';
Expand Down
4 changes: 2 additions & 2 deletions integrations/libraries/anythingllm.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ AnythingLLM is an all-in-one Desktop & Docker AI application with built-in RAG a
This guide shows how to configure AnythingLLM with Portkey in under 5 minutes.

<Note>
For enterprise deployments across teams, see [Enterprise Governance](#3-enterprise-governance).
For enterprise deployments across teams, see [Enterprise Governance](#3-set-up-enterprise-governance).
</Note>

# 1. Setup
Expand Down Expand Up @@ -73,7 +73,7 @@ Change models by updating the **Chat Model** field:
All requests route through Portkey automatically.

<Note>
**Want fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set Chat Model to `dummy`. See [Enterprise Governance](#3-enterprise-governance) for examples.
**Want fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set Chat Model to `dummy`. See [Enterprise Governance](#3-set-up-enterprise-governance) for examples.
</Note>

import AdvancedFeatures from '/snippets/portkey-advanced-features.mdx';
Expand Down
4 changes: 2 additions & 2 deletions integrations/libraries/cline.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Cline is an AI coding assistant for VS Code. Add Portkey to get:
This guide shows how to configure Cline with Portkey in under 5 minutes.

<Note>
For enterprise deployments across teams, see [Enterprise Governance](#3-enterprise-governance).
For enterprise deployments across teams, see [Enterprise Governance](#3-set-up-enterprise-governance).
</Note>

# 1. Setup
Expand Down Expand Up @@ -82,7 +82,7 @@ Change models by updating the **Model ID** field:
All requests route through Portkey automatically.

<Note>
**Want fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set Model ID to `dummy`. See [Enterprise Governance](#3-enterprise-governance) for examples.
**Want fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set Model ID to `dummy`. See [Enterprise Governance](#3-set-up-enterprise-governance) for examples.
</Note>

import AdvancedFeatures from '/snippets/portkey-advanced-features.mdx';
Expand Down
4 changes: 2 additions & 2 deletions integrations/libraries/codex.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ description: 'Add usage tracking, cost controls, and security guardrails to Code
Configure Codex with Portkey in a few minutes.

<Note>
For enterprise deployments across teams, see [Enterprise Governance](#3-enterprise-governance).
For enterprise deployments across teams, see [Enterprise Governance](#3-set-up-enterprise-governance).
</Note>

## Quick setup with CLI
Expand Down Expand Up @@ -185,7 +185,7 @@ wire_api = "chat"


<Note>
**Fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set `model` to the config’s virtual model. See [Enterprise Governance](#3-enterprise-governance) for examples.
**Fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set `model` to the config’s virtual model. See [Enterprise Governance](#3-set-up-enterprise-governance) for examples.
</Note>

import AdvancedFeatures from '/snippets/portkey-advanced-features.mdx';
Expand Down
2 changes: 1 addition & 1 deletion integrations/libraries/conductor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description: 'Add usage tracking, cost controls, and security guardrails to Cond
- **Governance** — budget limits, usage tracking, and team access controls

<Note>
For enterprise deployments across teams, see [Enterprise Governance](#3-enterprise-governance).
For enterprise deployments across teams, see [Enterprise Governance](#3-set-up-enterprise-governance).
</Note>

## 1. Setup
Expand Down
4 changes: 2 additions & 2 deletions integrations/libraries/continue-dev.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Continue.dev is an open-source AI coding assistant for VS Code and JetBrains. Ad
This guide shows how to configure Continue.dev with Portkey in under 5 minutes.

<Note>
For enterprise deployments across teams, see [Enterprise Governance](#3-enterprise-governance).
For enterprise deployments across teams, see [Enterprise Governance](#3-set-up-enterprise-governance).
</Note>

---
Expand Down Expand Up @@ -258,7 +258,7 @@ models:
```

<Note>
**Want fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set `x-portkey-config` to your Config ID in `requestOptions.headers`. See [Enterprise Governance](#3-enterprise-governance) for examples.
**Want fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set `x-portkey-config` to your Config ID in `requestOptions.headers`. See [Enterprise Governance](#3-set-up-enterprise-governance) for examples.
</Note>

---
Expand Down
2 changes: 1 addition & 1 deletion integrations/libraries/cursor.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ description: "Add observability, governance, and reliability to Cursor with Port
</Note>

<Note>
For enterprise governance, see [Enterprise Governance](#enterprise-governance).
For enterprise governance, see [Enterprise Governance](#3-set-up-enterprise-governance).
</Note>

## 1. Setup
Expand Down
4 changes: 2 additions & 2 deletions integrations/libraries/goose.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Goose is an open source AI agent that automates engineering tasks. Add Portkey t
This guide shows how to configure Goose with Portkey in under 5 minutes.

<Note>
For enterprise deployments across teams, see [Enterprise Governance](#3-enterprise-governance).
For enterprise deployments across teams, see [Enterprise Governance](#3-set-up-enterprise-governance).
</Note>

# 1. Setup
Expand Down Expand Up @@ -72,7 +72,7 @@ Change models by updating the model field:
All requests route through Portkey automatically.

<Note>
**Want fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set Model to `dummy`. See [Enterprise Governance](#3-enterprise-governance) for examples.
**Want fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set Model to `dummy`. See [Enterprise Governance](#3-set-up-enterprise-governance) for examples.
</Note>

import AdvancedFeatures from '/snippets/portkey-advanced-features.mdx';
Expand Down
4 changes: 2 additions & 2 deletions integrations/libraries/janhq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Jan is an open source alternative to ChatGPT that runs 100% offline on your comp
This guide shows how to configure Jan with Portkey in under 5 minutes.

<Note>
For enterprise deployments across teams, see [Enterprise Governance](#3-enterprise-governance).
For enterprise deployments across teams, see [Enterprise Governance](#3-set-up-enterprise-governance).
</Note>

# 1. Setup
Expand Down Expand Up @@ -69,7 +69,7 @@ Change models by updating the model selection:
All requests route through Portkey automatically.

<Note>
**Want fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set Model to `dummy`. See [Enterprise Governance](#3-enterprise-governance) for examples.
**Want fallbacks, load balancing, or caching?** Create a [Portkey Config](/product/ai-gateway/configs), attach it to your API key, and set Model to `dummy`. See [Enterprise Governance](#3-set-up-enterprise-governance) for examples.
</Note>

import AdvancedFeatures from '/snippets/portkey-advanced-features.mdx';
Expand Down
Loading