Skip to main content
Available on all Portkey plans.
Configs streamline your Gateway management, enabling you to programmatically control various aspects like fallbacks, load balancing, retries, caching, and more. A configuration is a JSON object that can be used to define routing rules for all the requests coming to your gateway. You can configure multiple configs and use them in your requests.

​
Creating Configs

Navigate to the ‘Configs’ page in the Portkey app and click ‘Create’ to start writing a new config.

​
Using Configs

Configs are supported across all integrations.
  • Through the config parameter of the Portkey SDK client(Directly or via frameworks)
  • Through the config headers in the OpenAI SDK
  • Via the REST API through the x-portkey-config header

​
Applying Gateway Configs

Gateway configs allow you to unlock the gateway superpowers of Portkey. You can create a config in the UI and attach it’s config id in the OpenAI client.
  • NodeJS
  • Python
  • OpenAI NodeJS
  • OpenAI Python
  • cURL
const portkey = new Portkey({
    apiKey: "PORTKEY_API_KEY",
    config: "pc-***" // Supports a string config id or a config object
});
If you want to attach the configuration to only a few requests instead of modifying the client, you can send it in the request headers for OpenAI or in the config parameter while using the Portkey SDK.
Note: If you have a default configuration set in the client, but also include a configuration in a specific request, the request-specific configuration will take precedence and replace the default config for that particular request.
  • NodeJS
  • Python
  • OpenAI NodeJS
  • OpenAI Python
portkey.chat.completions.create({
  messages: [{role: "user", content: "Say this is a test"}],
  model: "gpt-3.5-turbo"
}, {config: "pc-***"})
You can also add the config JSON as a string instead of the slug.

​
Configs in Logs

Portkey shows your Config usage smartly on the logs page with the Status column and gives you a snapshot of the Gateway activity for every request. Read more about the status column here. You can also see the ID of the specific Config used for a request separately in the log details, and jump into viewing/editing it directly from the log details page.

​
Config Object Documentation

Find detailed info about the Config object schema, and more examples:

Config Schema