Provider Slug:
openaiOverview
Portkey integrates with OpenAI’s APIs to help you create production-grade AI sppd with enhanced reliability, observability, and governance features.Getting Started
Obtain your OpenAI API Key
Visit the OpenAI dashboard to generate your API key.
Add OpenAI to Model Catalog
Add your OpenAI API key to Model Catalog to create an AI Provider. This gives you centralized key management with budget limits and rate limits per provider.
Initialize the Portkey Client
Supported Models
Supported OpenAI Models
Supported OpenAI Models
- GPT-4o
- GPT-4o mini
- o1-preview
- o1-mini
- GPT-4 Turbo
- GPT-4
- GPT-3.5 Turbo
- DALL·E
- TTS (Text-to-Speech)
- Whisper
- Embeddings
- Moderation
- GPT base
OpenAI Supported Features
Chat Completions
Generate chat completions using OpenAI models through Portkey:Streaming
Stream responses for real-time output in your applications:Function Calling
Leverage OpenAI’s function calling capabilities through Portkey:Vision
Process images alongside text using OpenAI’s vision capabilities:Embeddings
Generate embeddings for text using OpenAI’s embedding models:Transcription and Translation
Portkey supports bothTranscription and Translation methods for STT models:
Text to Speech
Convert text to speech using OpenAI’s TTS models:Prompt Caching
Implement prompt caching to improve performance and reduce costs:Prompt Caching Guide
Learn how to implement prompt caching for OpenAI models with Portkey.
Structured Output
Use structured outputs for more consistent and parseable responses:Structured Outputs Guide
Discover how to use structured outputs with OpenAI models in Portkey.
Supported Endpoints and Parameters
| Endpoint | Supported Parameters |
|---|---|
complete | model, prompt, max_tokens, temperature, top_p, n, stream, logprobs, echo, stop, presence_penalty, frequency_penalty, best_of, logit_bias, user, seed, suffix |
embed | model, input, encoding_format, dimensions, user |
chatComplete | model, messages, functions, function_call, max_tokens, temperature, top_p, n, stream, stop, presence_penalty, frequency_penalty, logit_bias, user, seed, tools, tool_choice, response_format, logprobs, top_logprobs, stream_options, service_tier, parallel_tool_calls, max_completion_tokens |
imageGenerate | prompt, model, n, quality, response_format, size, style, user |
createSpeech | model, input, voice, response_format, speed |
createTranscription | All parameters supported |
createTranslation | All parameters supported |
Portkey’s Advanced Features
Track End-User IDs
Portkey allows you to track user IDs passed with the user parameter in OpenAI requests, enabling you to monitor user-level costs, requests, and more:
user parameter, Portkey allows you to send arbitrary custom metadata with your requests. This powerful feature enables you to associate additional context or information with each request, which can be useful for analysis, debugging, or other custom use cases.
Learn More About Metadata
Explore how to use custom metadata to enhance your request tracking and analysis.
Using The Gateway Config
Here’s a simplified version of how to use Portkey’s Gateway Configuration:Create a Gateway Configuration
You can create a Gateway configuration using the Portkey Config Dashboard or by writing a JSON configuration in your code. In this example, requests are routed based on the user’s subscription plan (paid or free).
Process Requests
When a user makes a request, it will pass through Portkey’s AI Gateway. Based on the configuration, the Gateway routes the request according to the user’s metadata.

Load Balancing
Distribute requests across multiple targets based on defined weights.
Fallbacks
Automatically switch to backup targets if the primary target fails.
Conditional Routing
Route requests to different targets based on specified conditions.
Caching
Enable caching of responses to improve performance and reduce costs.
Guardrails
Portkey’s AI gateway enables you to enforce input/output checks on requests by applying custom hooks before and after processing. Protect your user’s/company’s data by using PII guardrails and many more available on Portkey Guardrails:Learn More About Guardrails
Explore Portkey’s guardrail features to enhance the security and reliability of your AI applications.
Next Steps
The complete list of features supported in the SDK are available in our comprehensive documentation:Portkey SDK Documentation
Explore the full capabilities of the Portkey SDK and how to leverage them in your projects.

