> ## Documentation Index
> Fetch the complete documentation index at: https://portkey-docs-feat-rerank-documentation.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAI Agents SDK (Python)

> Use Portkey with OpenAI Agents SDK to take your AI Agents to production

## Introduction

OpenAI Agents SDK enables the development of complex AI agents with tools, planning, and memory capabilities. Portkey enhances OpenAI Agents with observability, reliability, and production-readiness features.

Portkey turns your experimental OpenAI Agents into production-ready systems by providing:

* **Complete observability** of every agent step, tool use, and interaction
* **Built-in reliability** with fallbacks, retries, and load balancing
* **Cost tracking and optimization** to manage your AI spend
* **Access to 1600+ LLMs** through a single integration
* **Guardrails** to keep agent behavior safe and compliant
* **Version-controlled prompts** for consistent agent performance

<Card title="OpenAI Agents SDK Official Documentation" icon="arrow-up-right-from-square" href="https://openai.github.io/openai-agents-python/">
  Learn more about OpenAI Agents SDK's core concepts
</Card>

### Installation & Setup

<Steps>
  <Step title="Install the required packages">
    ```bash theme={"system"}
    pip install -U openai-agents portkey-ai
    ```
  </Step>

  <Step title="Generate API Key">
    Create a Portkey API key with optional budget/rate limits and attach your Config
  </Step>

  <Step title="Connect to OpenAI Agents">
    There are 3 ways to integrate Portkey with OpenAI Agents:

    1. Set a client that applies to all agents in your application
    2. Use a custom provider for selective Portkey integration
    3. Configure each agent individually

    See the [Integration Approaches](#integration-approaches) section for more details.
  </Step>

  <Step title="Configure Portkey Client">
    For a simple setup, we'll use the global client approach:

    ```python theme={"system"}
    from agents import (
        set_default_openai_client,
        set_default_openai_api,
        Agent, Runner
    )
    from openai import AsyncOpenAI
    from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders
    import os

    # Set up Portkey as the global client
    portkey = AsyncOpenAI(
        base_url=PORTKEY_GATEWAY_URL,
        api_key=os.environ["PORTKEY_API_KEY"],
        default_headers=createHeaders(
            provider="@YOUR_OPENAI_PROVIDER"
        )
    )

    # Register as the SDK-wide default
    set_default_openai_client(portkey, use_for_tracing=False)
    set_default_openai_api("chat_completions")  # Responses API → Chat
    ```
  </Step>
</Steps>

### Getting Started

Let's create a simple question-answering agent with OpenAI Agents SDK and Portkey. This agent will respond directly to user messages using a language model:

```python theme={"system"}
from agents import (
    set_default_openai_client,
    set_default_openai_api,
    Agent, Runner
)
from openai import AsyncOpenAI
from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders
import os

# Set up Portkey as the global client
portkey = AsyncOpenAI(
    base_url=PORTKEY_GATEWAY_URL,
    api_key=os.environ["PORTKEY_API_KEY"],
    default_headers=createHeaders(
        provider="@YOUR_OPENAI_PROVIDER"
    )
)

# Register as the SDK-wide default
set_default_openai_client(portkey, use_for_tracing=False)
set_default_openai_api("chat_completions")  # Responses API → Chat

# Create agent with any supported model
agent = Agent(
    name="Assistant",
    instructions="You are a helpful assistant.",
    model="gpt-4o"  # Using Anthropic Claude through Portkey
)

# Run the agent
result = Runner.run_sync(agent, "Tell me about quantum computing.")
print(result.final_output)
```

In this example:

1. We set up Portkey as the global client for OpenAI Agents SDK
2. We create a simple agent with instructions and a model
3. We run the agent synchronously with a user query
4. We print the final output

Visit your Portkey dashboard to see detailed logs of this agent's execution!

### Integration Approaches

There are three ways to integrate Portkey with OpenAI Agents SDK, each suited for different scenarios:

<Tabs>
  <Tab title="Global Default Client">
    Set a global client that affects all agents in your application:

    ```python theme={"system"}
    from agents import (
        set_default_openai_client,
        set_default_openai_api,
        set_tracing_disabled,
        Agent, Runner
    )
    from openai import AsyncOpenAI
    from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders
    import os

    # Set up Portkey as the global client
    portkey = AsyncOpenAI(
        base_url=PORTKEY_GATEWAY_URL,
        api_key=os.environ["PORTKEY_API_KEY"],
        default_headers=createHeaders(
            provider="@YOUR_OPENAI_PROVIDER"
        )
    )

    # Register it as the SDK-wide default
    set_default_openai_client(portkey, use_for_tracing=False)   # skip OpenAI tracing
    set_default_openai_api("chat_completions")                  # Responses API → Chat
    set_tracing_disabled(True)                                  # optional

    # Regular agent code—just a model name
    agent = Agent(
        name="Haiku Writer",
        instructions="Respond only in haikus.",
        model="claude-3-7-sonnet-latest"
    )

    print(Runner.run_sync(agent, "Write a haiku on recursion.").final_output)
    ```

    **Best for**: Whole application migration to Portkey with minimal code changes
  </Tab>

  <Tab title="ModelProvider with RunConfig">
    Use a custom ModelProvider to control which runs use Portkey:

    ```python theme={"system"}
    from agents import (
        Model,
        ModelProvider,
        RunConfig,
        Runner,
        Agent
    )
    from agents import OpenAIChatCompletionsModel           # concrete Model
    from openai import AsyncOpenAI
    from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders
    import os, asyncio


    client = AsyncOpenAI(
        base_url=PORTKEY_GATEWAY_URL,
        api_key=os.environ["PORTKEY_API_KEY"],
        default_headers=createHeaders(
            provider="@YOUR_OPENAI_PROVIDER"
        )
    )

    class PortkeyProvider(ModelProvider):
        def get_model(self, model_name: str | None) -> Model:
            return OpenAIChatCompletionsModel(
                model=model_name or "claude-3-7-sonnet-latest",
                openai_client=client
            )

    PORTKEY = PortkeyProvider()                              # singleton is fine

    async def main():
        agent = Agent(name="Assistant", instructions="Haikus only.")
        run_cfg = RunConfig(model_provider=PORTKEY)

        # Only this call uses Portkey
        out = await Runner.run(agent, "Weather in Tokyo?", run_config=run_cfg)
        print(out.final_output)

    asyncio.run(main())
    ```

    **Best for**: A/B testing, staged rollouts, or toggling between providers at runtime
  </Tab>

  <Tab title="Per-Agent Model Object">
    Attach a specific Model object to each Agent:

    ```python theme={"system"}
    from agents import Agent, Runner, OpenAIChatCompletionsModel
    from openai import AsyncOpenAI
    from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders
    import os


    portkey_client = AsyncOpenAI(
        base_url=PORTKEY_GATEWAY_URL,
        api_key=os.environ["PORTKEY_API_KEY"],
        default_headers=createHeaders(
            provider="@YOUR_OPENAI_PROVIDER"
        )
    )


    agent = Agent(
        name="Haiku Writer",
        instructions="Classic Japanese form.",
        model=OpenAIChatCompletionsModel(                   # concrete Model
            model="claude-3-7-sonnet-latest",
            openai_client=portkey_client
        ),
    )

    print(Runner.run_sync(agent, "Recursion haiku.").final_output)
    ```

    **Best for**: Mixed agent environments where different agents need different providers or configurations
  </Tab>
</Tabs>

**Comparing the 3 approaches**

| Strategy                                          | Code Touchpoints                              | Best For                                                 |
| :------------------------------------------------ | :-------------------------------------------- | :------------------------------------------------------- |
| **Global Client** via `set_default_openai_client` | One-time setup; agents need only model names  | Whole app uses Portkey; simplest migration               |
| **ModelProvider in RunConfig**                    | Add a provider + pass `run_config`            | Toggle Portkey per run; A/B tests, staged rollouts       |
| **Explicit Model per Agent**                      | Specify `OpenAIChatCompletionsModel` in agent | Mixed fleet: each agent can talk to a different provider |

## End-to-End Example

**Research Agent with Tools**: Here's a more comprehensive agent that can use tools to perform tasks.

```python [expandable] theme={"system"}
from agents import Agent, Runner, Tool, set_default_openai_client
from openai import AsyncOpenAI
from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders
import os

# Configure Portkey client
portkey = AsyncOpenAI(
    api_key=os.environ.get("PORTKEY_API_KEY"),
    base_url=PORTKEY_GATEWAY_URL,
    default_headers=createHeaders(
        provider="@YOUR_OPENAI_PROVIDER"
    )
)
set_default_openai_client(portkey)

# Define agent tools
def get_weather(location: str) -> str:
    """Get the current weather for a location."""
    return f"It's 72°F and sunny in {location}."

def search_web(query: str) -> str:
    """Search the web for information."""
    return f"Found information about: {query}"

# Create agent with tools
agent = Agent(
    name="Research Assistant",
    instructions="You are a helpful assistant that can search for information and check the weather.",
    model="claude-3-opus-20240229",
    tools=[
        Tool(
            name="get_weather",
            description="Get current weather for a location",
            input_schema={
                "location": {
                    "type": "string",
                    "description": "City and state, e.g. San Francisco, CA"
                }
            },
            callback=get_weather
        ),
        Tool(
            name="search_web",
            description="Search the web for information",
            input_schema={
                "query": {
                    "type": "string",
                    "description": "Search query"
                }
            },
            callback=search_web
        )
    ]
)

# Run the agent
result = Runner.run_sync(
    agent,
    "What's the weather in San Francisco and find information about Golden Gate Bridge?"
)
print(result.final_output)
```

Visit your Portkey dashboard to see the complete execution flow visualized!

***

## Production Features

### 1. Enhanced Observability

Portkey provides comprehensive observability for your OpenAI Agents, helping you understand exactly what's happening during each execution.

<Tabs>
  <Tab title="Traces">
    <Frame>
      <img src="https://mintcdn.com/portkey-docs-feat-rerank-documentation/WdbowXXxTzLVVwYF/images/product/product-11-1.webp?fit=max&auto=format&n=WdbowXXxTzLVVwYF&q=85&s=945c41603fce9e4fdec53a8334fc7c92" width="2224" height="1166" data-path="images/product/product-11-1.webp" />
    </Frame>

    Traces provide a hierarchical view of your agent's execution, showing the sequence of LLM calls, tool invocations, and state transitions.

    ```python theme={"system"}
      # Add tracing to your OpenAI Agents
      portkey = AsyncOpenAI(
          base_url=PORTKEY_GATEWAY_URL,
          api_key=os.environ["PORTKEY_API_KEY"],
          default_headers=createHeaders(
              trace_id="unique_execution_trace_id", # Add unique trace ID
              provider="@YOUR_OPENAI_PROVIDER"
          )
      )
      set_default_openai_client(portkey)
    ```
  </Tab>

  <Tab title="Logs">
    <Frame>
      <img src="https://mintcdn.com/portkey-docs-feat-rerank-documentation/WdbowXXxTzLVVwYF/images/product/product-2.avif?fit=max&auto=format&n=WdbowXXxTzLVVwYF&q=85&s=d7414359f90b1783eeb5fd24f836830a" width="800" height="492" data-path="images/product/product-2.avif" />
    </Frame>

    Portkey logs every interaction with LLMs, including:

    * Complete request and response payloads
    * Latency and token usage metrics
    * Cost calculations
    * Tool calls and function executions

    All logs can be filtered by metadata, trace IDs, models, and more, making it easy to debug specific agent runs.
  </Tab>

  <Tab title="Metrics & Dashboards">
    <Frame>
      <img src="https://mintcdn.com/portkey-docs-feat-rerank-documentation/Cg9s-posKHJ6UAN_/images/product/dashboard.png?fit=max&auto=format&n=Cg9s-posKHJ6UAN_&q=85&s=770f75b1e7758b2bdc4f0a0188304efe" width="600" height="348" data-path="images/product/dashboard.png" />
    </Frame>

    Portkey provides built-in dashboards that help you:

    * Track cost and token usage across all agent runs
    * Analyze performance metrics like latency and success rates
    * Identify bottlenecks in your agent workflows
    * Compare different agent configurations and LLMs

    You can filter and segment all metrics by custom metadata to analyze specific agent types, user groups, or use cases.
  </Tab>

  <Tab title="Metadata Filtering">
    <Frame>
      <img src="https://mintcdn.com/portkey-docs-feat-rerank-documentation/igF6AIVPgbUAWApF/images/metadata.png?fit=max&auto=format&n=igF6AIVPgbUAWApF&q=85&s=67497d5dd8bed7ff942a240583238b2c" alt="Analytics with metadata filters" width="3156" height="1876" data-path="images/metadata.png" />
    </Frame>

    Add custom metadata to your OpenAI agent calls to enable powerful filtering and segmentation:

    ```python theme={"system"}

      # Add tracing to your OpenAI Agents
      portkey = AsyncOpenAI(
          base_url=PORTKEY_GATEWAY_URL,
          api_key=os.environ["PORTKEY_API_KEY"],
          default_headers=createHeaders(
              metadata={"agent_type": "research_agent"}, # Add custom metadata
              provider="@YOUR_OPENAI_PROVIDER"
          )
      )
      set_default_openai_client(portkey)
    ```

    This metadata can be used to filter logs, traces, and metrics on the Portkey dashboard, allowing you to analyze specific agent runs, users, or environments.
  </Tab>
</Tabs>

### 2. Reliability - Keep Your Agents Running Smoothly

When running agents in production, things can go wrong - API rate limits, network issues, or provider outages. Portkey's reliability features ensure your agents keep running smoothly even when problems occur.

It's this simple to enable fallback in your OpenAI Agents:

```python theme={"system"}
from portkey_ai import createHeaders, PORTKEY_GATEWAY_URL
from openai import AsyncOpenAI
from agents import set_default_openai_client

# Create a config with fallbacks, It's recommended that you create the Config in Portkey App rather than hard-code the config JSON directly
config = {
  "strategy": {
    "mode": "fallback"
  },
  "targets": [
    {
      "provider": "openai",
      "override_params": {"model": "gpt-4o"}
    },
    {
      "provider": "anthropic",
      "override_params": {"model": "claude-3-opus-20240229"}
    }
  ]
}

# Configure Portkey client with fallback config
portkey = AsyncOpenAI(
    base_url=PORTKEY_GATEWAY_URL,
    api_key=os.environ["PORTKEY_API_KEY"],
    default_headers=createHeaders(config=config)
)
set_default_openai_client(portkey)
```

This configuration will automatically try Claude if the GPT-4o request fails, ensuring your agent can continue operating.

<CardGroup cols="2">
  <Card title="Automatic Retries" icon="rotate" href="../../product/ai-gateway/automatic-retries">
    Handles temporary failures automatically. If an LLM call fails, Portkey will retry the same request for the specified number of times - perfect for rate limits or network blips.
  </Card>

  <Card title="Request Timeouts" icon="clock" href="../../product/ai-gateway/request-timeouts">
    Prevent your agents from hanging. Set timeouts to ensure you get responses (or can fail gracefully) within your required timeframes.
  </Card>

  <Card title="Conditional Routing" icon="route" href="../../product/ai-gateway/conditional-routing">
    Send different requests to different providers. Route complex reasoning to GPT-4, creative tasks to Claude, and quick responses to Gemini based on your needs.
  </Card>

  <Card title="Fallbacks" icon="shield" href="../../product/ai-gateway/fallbacks">
    Keep running even if your primary provider fails. Automatically switch to backup providers to maintain availability.
  </Card>

  <Card title="Load Balancing" icon="scale-balanced" href="../../product/ai-gateway/load-balancing">
    Spread requests across multiple API keys or providers. Great for high-volume agent operations and staying within rate limits.
  </Card>
</CardGroup>

### 3. Prompting in OpenAI Agents

Portkey's Prompt Engineering Studio helps you create, manage, and optimize the prompts used in your OpenAI Agents. Instead of hardcoding prompts or instructions, use Portkey's prompt rendering API to dynamically fetch and apply your versioned prompts.

<Frame caption="Manage prompts in Portkey's Prompt Library">
  <img src="https://mintcdn.com/portkey-docs-feat-rerank-documentation/OMdFE_PDcXKW4zok/images/product/ai-gateway/ai-20.webp?fit=max&auto=format&n=OMdFE_PDcXKW4zok&q=85&s=4520701243bbbea39d82342f5a702d5c" alt="Prompt Playground Interface" width="2304" height="1302" data-path="images/product/ai-gateway/ai-20.webp" />
</Frame>

<Tabs>
  <Tab title="Prompt Playground">
    Prompt Playground is a place to compare, test and deploy perfect prompts for your AI application. It’s where you experiment with different models, test variables, compare outputs, and refine your prompt engineering strategy before deploying to production. It allows you to:

    1. Iteratively develop prompts before using them in your agents
    2. Test prompts with different variables and models
    3. Compare outputs between different prompt versions
    4. Collaborate with team members on prompt development

    This visual environment makes it easier to craft effective prompts for each step in your OpenAI Agents agent's workflow.
  </Tab>

  <Tab title="Using Prompt Templates">
    The Prompt Render API retrieves your prompt templates with all parameters configured:

    ```python theme={"system"}
    from openai import AsyncOpenAI
    from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders
    from agents import Agent, Runner, set_default_openai_client

    # Initialize Portkey client
    portkey_client = Portkey(api_key="PORTKEY_API_KEY")

    # Retrieve prompt using the render API
    prompt_data = portkey_client.prompts.render(
        prompt_id="YOUR_PROMPT_ID",
        variables={
            "user_input": "Tell me about artificial intelligence"
        }
    )

    # Configure OpenAI client with Portkey
    openai_client = AsyncOpenAI(
        base_url=PORTKEY_GATEWAY_URL,
        api_key="YOUR_PORTKEY_API_KEY",
        default_headers=createHeaders(
            provider="@YOUR_OPENAI_PROVIDER"
        )
    )
    set_default_openai_client(openai_client)

    # Use the rendered prompt in your OpenAI Agent
    agent = Agent(
        name="Assistant",
        instructions=prompt_data.data.messages[0]["content"],  # Use the rendered prompt as instructions
        model="gpt-4o"
    )

    result = Runner.run_sync(agent, "Tell me about artificial intelligence")
    print(result.final_output)
    ```
  </Tab>

  <Tab title="Prompt Versioning">
    You can:

    * Create multiple versions of the same prompt
    * Compare performance between versions
    * Roll back to previous versions if needed
    * Specify which version to use in your code:

    ```python theme={"system"}
    # Use a specific prompt version
    prompt_data = portkey_client.prompts.render(
        prompt_id="YOUR_PROMPT_ID@version_number",
        variables={
            "user_input": "Tell me about quantum computing"
        }
    )
    ```
  </Tab>

  <Tab title="Mustache Templating for variables">
    Portkey prompts use Mustache-style templating for easy variable substitution:

    ```
    You are an AI assistant helping with {{task_type}}.

    User question: {{user_input}}

    Please respond in a {{tone}} tone and include {{required_elements}}.
    ```

    When rendering, simply pass the variables:

    ```python theme={"system"}
    prompt_data = portkey_client.prompts.render(
        prompt_id="YOUR_PROMPT_ID",
        variables={
            "task_type": "research",
            "user_input": "Tell me about quantum computing",
            "tone": "professional",
            "required_elements": "recent academic references"
        }
    )
    ```
  </Tab>
</Tabs>

<Card title="Prompt Engineering Studio" icon="wand-magic-sparkles" href="/product/prompt-library">
  Learn more about Portkey's prompt management features
</Card>

### 4. Guardrails for Safe Agents

Guardrails ensure your OpenAI Agents operate safely and respond appropriately in all situations.

**Why Use Guardrails?**

OpenAI Agents can experience various failure modes:

* Generating harmful or inappropriate content
* Leaking sensitive information like PII
* Hallucinating incorrect information
* Generating outputs in incorrect formats

Portkey's guardrails protect against these issues by validating both inputs and outputs.

**Implementing Guardrails**

```python theme={"system"}
from portkey_ai import createHeaders, PORTKEY_GATEWAY_URL
from openai import AsyncOpenAI
from agents import set_default_openai_client

# Create a config with input and output guardrails, It's recommended you create Config in Portkey App and pass the config ID in the client
config = {
    "provider":"@openai-xxx",
    "input_guardrails": ["guardrails-id-xxx", "guardrails-id-yyy"],
    "output_guardrails": ["guardrails-id-xxx"]
}

# Configure OpenAI client with guardrails
portkey = AsyncOpenAI(
    base_url=PORTKEY_GATEWAY_URL,
    api_key=os.environ["PORTKEY_API_KEY"],
    default_headers=createHeaders(
        config=config,
        provider="@YOUR_OPENAI_PROVIDER"
    )
)
set_default_openai_client(portkey)
```

Portkey's guardrails can:

* Detect and redact PII in both inputs and outputs
* Filter harmful or inappropriate content
* Validate response formats against schemas
* Check for hallucinations against ground truth
* Apply custom business logic and rules

<Card title="Learn More About Guardrails" icon="shield-check" href="/product/guardrails">
  Explore Portkey's guardrail features to enhance agent safety
</Card>

### 5. User Tracking with Metadata

Track individual users through your OpenAI Agents using Portkey's metadata system.

**What is Metadata in Portkey?**

Metadata allows you to associate custom data with each request, enabling filtering, segmentation, and analytics. The special `_user` field is specifically designed for user tracking.

```python theme={"system"}
from portkey_ai import createHeaders, PORTKEY_GATEWAY_URL
from openai import AsyncOpenAI
from agents import set_default_openai_client

# Configure client with user tracking
portkey = AsyncOpenAI(
    base_url=PORTKEY_GATEWAY_URL,
    api_key=os.environ["PORTKEY_API_KEY"],
    default_headers=createHeaders(
        provider="@YOUR_LLM_PROVIDER",
        metadata={
            "_user": "user_123", # Special _user field for user analytics
            "user_name": "John Doe",
            "user_tier": "premium",
            "user_company": "Acme Corp"
        }
    )
)
set_default_openai_client(portkey)
```

**Filter Analytics by User**

With metadata in place, you can filter analytics by user and analyze performance metrics on a per-user basis:

<Frame caption="Filter analytics by user">
  <img src="https://mintcdn.com/portkey-docs-feat-rerank-documentation/igF6AIVPgbUAWApF/images/metadata-filters.png?fit=max&auto=format&n=igF6AIVPgbUAWApF&q=85&s=c2fa314f9949b94c9e71fcad44673dc8" width="1158" height="732" data-path="images/metadata-filters.png" />
</Frame>

This enables:

* Per-user cost tracking and budgeting
* Personalized user analytics
* Team or organization-level metrics
* Environment-specific monitoring (staging vs. production)

<Card title="Learn More About Metadata" icon="tags" href="/product/observability/metadata">
  Explore how to use custom metadata to enhance your analytics
</Card>

### 6. Caching for Efficient Agents

Implement caching to make your OpenAI Agents agents more efficient and cost-effective:

<Tabs>
  <Tab title="Simple Caching">
    ```python theme={"system"}
    portkey_config = {
      "cache": {
        "mode": "simple"
      },
      "provider":"@YOUR_LLM_PROVIDER"
    }

    # Configure OpenAI client with chosen provider
    portkey = AsyncOpenAI(
        base_url=PORTKEY_GATEWAY_URL,
        api_key=os.environ["PORTKEY_API_KEY"],
        default_headers=createHeaders(config=portkey_config)
    )
    set_default_openai_client(portkey)
    ```

    Simple caching performs exact matches on input prompts, caching identical requests to avoid redundant model executions.
  </Tab>

  <Tab title="Semantic Caching">
    ```python theme={"system"}
      portkey_config = {
        "cache": {
          "mode": "semantic"
        },
        "provider":"@YOUR_LLM_PROVIDER"
      }

      # Configure OpenAI client with chosen provider
      portkey = AsyncOpenAI(
          base_url=PORTKEY_GATEWAY_URL,
          api_key=os.environ["PORTKEY_API_KEY"],
          default_headers=createHeaders(config=portkey_config)
      )
      set_default_openai_client(portkey)
    ```

    Semantic caching considers the contextual similarity between input requests, caching responses for semantically similar inputs.
  </Tab>
</Tabs>

### 7. Model Interoperability

With Portkey, you can easily switch between different LLMs in your OpenAI Agents without changing your core agent logic.

```python theme={"system"}
# Configure Portkey with different LLM providers
from portkey_ai import createHeaders, PORTKEY_GATEWAY_URL
from openai import AsyncOpenAI
from agents import set_default_openai_client

# Using OpenAI
openai_config = {
    "provider": "@openai-prod",
    "override_params": {"model": "gpt-4o"}
}

# Using Anthropic
anthropic_config = {
    "provider": "@anthropic-prod",
    "override_params": {"model": "claude-3-5-sonnet-latest"}
}

# Choose which config to use
active_config = openai_config  # or anthropic_config

# Configure OpenAI client with chosen provider
portkey = AsyncOpenAI(
    base_url=PORTKEY_GATEWAY_URL,
    api_key=os.environ["PORTKEY_API_KEY"],
    default_headers=createHeaders(config=active_config)
)
set_default_openai_client(portkey)

# Create and run agent - no changes needed in agent code
agent = Agent(
    name="Assistant",
    instructions="You are a helpful assistant.",
    # The model specified here will be used as a reference but the actual model
    # is determined by the active_config
    model="gpt-4o"
)

result = Runner.run_sync(agent, "Tell me about quantum computing.")
print(result.final_output)
```

Portkey provides access to over 200 LLMs through a unified interface, including:

* OpenAI (GPT-4o, GPT-4 Turbo, etc.)
* Anthropic (Claude 3.5 Sonnet, Claude 3 Opus, etc.)
* Mistral AI (Mistral Large, Mistral Medium, etc.)
* Google Vertex AI (Gemini 1.5 Pro, etc.)
* Cohere (Command, Command-R, etc.)
* AWS Bedrock (Claude, Titan, etc.)
* Local/Private Models

<Card title="Supported Providers" icon="server" href="/integrations/llms">
  See the full list of LLM providers supported by Portkey
</Card>

### 8. Tracing

Portkey provides an opentelemetry compatible backend to store and query your traces.

You can trace your OpenAI Agents using any OpenTelemetry compatible tracing library.

Here is an example of how to trace your OpenAI Agents using the [`logfire`](/integrations/tracing-providers/logfire) library from Pydantic:

```python Python theme={"system"}
import logfire
from pydantic import BaseModel
from agents import Agent, Runner, function_tool
import asyncio
import os

os.environ["OTEL_EXPORTER_OTLP_ENDPOINT"] =  "https://api.portkey.com/v1/logs/otel"
os.environ["OTEL_EXPORTER_OTLP_HEADERS"] = f"x-portkey-api-key={YOUR_PORTKEY_API_KEY}"

class Weather(BaseModel):
    city: str
    temperature_range: str
    conditions: str

@function_tool
def get_weather(city: str) -> Weather:
    return Weather(city=city, temperature_range="14-20C", conditions="Sunny with wind.")

agent = Agent(
    name="Hello world",
    instructions="You are a helpful agent.",
    tools=[get_weather]
)

async def main():
    logfire.configure(
        service_name='my_agent_service',
        send_to_logfire=False,
    )
    logfire.instrument_openai_agents()
    result = await Runner.run(agent, input="What's the weather in Tokyo?")
    print(result.final_output)

if __name__ == "__main__":
    asyncio.run(main())
```

## Tool Use in OpenAI Agents

OpenAI Agents SDK natively supports tools that enable your agents to interact with external systems and APIs. Portkey provides full observability for tool usage in your agents:

```python [expandable] theme={"system"}
from agents import Agent, Runner, Tool, set_default_openai_client
from openai import AsyncOpenAI
from portkey_ai import PORTKEY_GATEWAY_URL, createHeaders
import os

# Configure Portkey client with tracing
portkey = AsyncOpenAI(
    base_url=PORTKEY_GATEWAY_URL,
    api_key=os.environ["PORTKEY_API_KEY"],
    default_headers=createHeaders(
        trace_id="tools_example",
        metadata={"agent_type": "research"}
    )
)
set_default_openai_client(portkey)

# Define tools
def get_weather(location: str, unit: str = "fahrenheit") -> str:
    """Get the current weather in a given location"""
    return f"The weather in {location} is 72 degrees {unit}"

def get_population(city: str, country: str) -> str:
    """Get the population of a city"""
    return f"The population of {city}, {country} is 1,000,000"

# Create agent with tools
agent = Agent(
    name="Research Assistant",
    instructions="You are a helpful assistant that can look up weather and population information.",
    model="gpt-4o-mini",
    tools=[
        Tool(
            name="get_weather",
            description="Get the current weather in a given location",
            input_schema={
                "location": {
                    "type": "string",
                    "description": "City and state, e.g. San Francisco, CA"
                },
                "unit": {
                    "type": "string",
                    "description": "Temperature unit (celsius or fahrenheit)",
                    "default": "fahrenheit"
                }
            },
            callback=get_weather
        ),
        Tool(
            name="get_population",
            description="Get the population of a city",
            input_schema={
                "city": {
                    "type": "string",
                    "description": "City name"
                },
                "country": {
                    "type": "string",
                    "description": "Country name"
                }
            },
            callback=get_population
        )
    ]
)

# Run the agent
result = Runner.run_sync(
    agent,
    "What's the weather in San Francisco and what's the population of Tokyo, Japan?"
)
print(result.final_output)
```

## Set Up Enterprise Governance for OpenAI Agents

**Why Enterprise Governance?**
If you are using OpenAI Agents inside your orgnaization, you need to consider several governance aspects:

* **Cost Management**: Controlling and tracking AI spending across teams
* **Access Control**: Managing which teams can use specific models
* **Usage Analytics**: Understanding how AI is being used across the organization
* **Security & Compliance**: Maintaining enterprise security standards
* **Reliability**: Ensuring consistent service across all users

Portkey adds a comprehensive governance layer to address these enterprise needs. Let's implement these controls step by step.

**Enterprise Implementation Guide**

Portkey allows you to use 1600+ LLMs with your OpenAI Agents setup, with minimal configuration required. Let's set up the core components in Portkey that you'll need for integration.

<Steps>
  <Step title="Add an AI Provider">
    Add your LLM provider credentials to Model Catalog. This gives you centralized control with:

    * Budget limits per provider
    * Rate limiting capabilities
    * Secure credential storage

    Go to [Model Catalog](https://app.portkey.ai/model-catalog) in the Portkey App and add your provider. Copy the AI Provider slug — you'll need it for the next step.
  </Step>

  <Step title="Create Default Config">
    Configs in Portkey are JSON objects that define how your requests are routed. They help with implementing features like advanced routing, fallbacks, and retries.

    We need to create a default config to route our requests to the AI Provider added in Step 1.

    To create your config:

    1. Go to [Configs](https://app.portkey.ai/configs) in Portkey dashboard
    2. Create new config with:
       ```json theme={"system"}
       {
           "provider":"@YOUR_PROVIDER_FROM_STEP1",
          	"override_params": {
             "model": "gpt-4o" // Your preferred model name
           }
       }

       ```
    3. Save and note the Config name for the next step

    <Frame>
      <img src="https://mintcdn.com/portkey-docs-feat-rerank-documentation/RZntptMrltN8qCDa/images/integrations/config.png?fit=max&auto=format&n=RZntptMrltN8qCDa&q=85&s=dd617d76d4e5fecce49713a18e010c86" width="500" data-path="images/integrations/config.png" />
    </Frame>

    <Note>
      This basic config connects to your AI Provider. You can add more advanced Portkey features later.
    </Note>
  </Step>

  <Step title="Configure Portkey API Key">
    Now create Portkey API key access point and attach the config you created in Step 2:

    1. Go to [API Keys](https://app.portkey.ai/api-keys) in Portkey and Create new API key
    2. Select your config from `Step 2`
    3. Generate and save your API key

    <Frame>
      <img src="https://mintcdn.com/portkey-docs-feat-rerank-documentation/RYP60dWu9sr_vT1l/images/integrations/api-key.png?fit=max&auto=format&n=RYP60dWu9sr_vT1l&q=85&s=fdb25867689baaeacb74c41156c029fa" width="500" data-path="images/integrations/api-key.png" />
    </Frame>

    <Note>
      Save your API key securely - you'll need it for OpenAI Agents integration.
    </Note>
  </Step>

  <Step>
    Once you have creted your API Key after attaching default config, you can directly pass the API key + base URL in the AsyncOpenAI client. Here's how:

    ```Python theme={"system"}
    from portkey_ai import createHeaders, PORTKEY_GATEWAY_URL
    from openai import AsyncOpenAI


    client=AsyncOpenAI(
    api_key="YOUR_PORTKEY_API_KEY", # Your Portkey API Key from Step 3
    base_url="PORTKEY_GATEWAY_URL"
    )

    # your rest of the code remains same
    ```
  </Step>
</Steps>

<AccordionGroup>
  <Accordion title="Step 1: Implement Budget Controls & Rate Limits">
    ### Step 1: Implement Budget Controls & Rate Limits

    AI Providers in Model Catalog enable granular control over LLM access at the team/department level. This helps you:

    * Set up [budget limits](/product/model-catalog/budget-limits)
    * Prevent unexpected usage spikes using rate limits
    * Track departmental spending

    #### Setting Up Department-Specific Controls:

    1. Navigate to [Model Catalog](https://app.portkey.ai/model-catalog) in the Portkey dashboard
    2. Add an AI Provider for each department with budget limits and rate limits
    3. Configure department-specific limits
  </Accordion>

  <Accordion title="Step 2: Define Model Access Rules">
    ### Step 2: Define Model Access Rules

    As your AI usage scales, controlling which teams can access specific models becomes crucial. Portkey Configs provide this control layer with features like:

    #### Access Control Features:

    * **Model Restrictions**: Limit access to specific models
    * **Data Protection**: Implement guardrails for sensitive data
    * **Reliability Controls**: Add fallbacks and retry logic

    #### Example Configuration:

    Here's a basic configuration to route requests to OpenAI, specifically using GPT-4o:

    ```json theme={"system"}
    {
    	"strategy": {
    		"mode": "single"
    	},
    	"targets": [
    		{
    			"provider":"@YOUR_OPENAI_PROVIDER",
    			"override_params": {
    				"model": "gpt-4o"
    			}
    		}
    	]
    }
    ```

    Create your config on the [Configs page](https://app.portkey.ai/configs) in your Portkey dashboard. You'll need the config ID for connecting to OpenAI Agents's setup.

    <Note>
      Configs can be updated anytime to adjust controls without affecting running applications.
    </Note>
  </Accordion>

  <Accordion title="Step 3: Implement Access Controls">
    ### Step 3: Implement Access Controls

    Create User-specific API keys that automatically:

    * Track usage per user/team with the help of metadata
    * Apply appropriate configs to route requests
    * Collect relevant metadata to filter logs
    * Enforce access permissions

    Create API keys through:

    * [Portkey App](https://app.portkey.ai/)
    * [API Key Management API](/api-reference/admin-api/control-plane/api-keys/create-api-key)

    Example using Python SDK:

    ```python theme={"system"}
    from portkey_ai import Portkey

    portkey = Portkey(api_key="YOUR_ADMIN_API_KEY")

    api_key = portkey.api_keys.create(
        name="engineering-team",
        type="organisation",
        workspace_id="YOUR_WORKSPACE_ID",
        defaults={
            "config_id": "your-config-id",
            "metadata": {
                "environment": "production",
                "department": "engineering"
            }
        },
        scopes=["logs.view", "configs.read"]
    )
    ```

    For detailed key management instructions, see our [API Keys documentation](/api-reference/admin-api/control-plane/api-keys/create-api-key).
  </Accordion>

  <Accordion title="Step 4: Deploy & Monitor">
    ### Step 4: Deploy & Monitor

    After distributing API keys to your team members, your enterprise-ready OpenAI Agents setup is ready to go. Each team member can now use their designated API keys with appropriate access levels and budget controls.
    Apply your governance setup using the integration steps from earlier sections
    Monitor usage in Portkey dashboard:

    * Cost tracking by department
    * Model usage patterns
    * Request volumes
    * Error rates
  </Accordion>
</AccordionGroup>

<Check>
  ### Enterprise Features Now Available

  **OpenAI Agents now has:**

  * Departmental budget controls
  * Model access governance
  * Usage tracking & attribution
  * Security guardrails
  * Reliability features
</Check>

## Frequently Asked Questions

<AccordionGroup>
  <Accordion title="How does Portkey enhance OpenAI Agents?">
    Portkey adds production-readiness to OpenAI Agents through comprehensive observability (traces, logs, metrics), reliability features (fallbacks, retries, caching), and access to 1600+ LLMs through a unified interface. This makes it easier to debug, optimize, and scale your agent applications.
  </Accordion>

  <Accordion title="Can I use Portkey with existing OpenAI Agents?">
    Yes! Portkey integrates seamlessly with existing OpenAI Agents. You only need to replace your client initialization code with the Portkey-enabled version. The rest of your agent code remains unchanged.
  </Accordion>

  <Accordion title="Does Portkey work with all OpenAI Agents features?">
    Portkey supports all OpenAI Agents SDK features, including tool use, memory, planning, and more. It adds observability and reliability without limiting any of the SDK's functionality.
  </Accordion>

  <Accordion title="How does Portkey handle streaming in OpenAI Agents?">
    Portkey fully supports streaming responses in OpenAI Agents. You can enable streaming by using the appropriate methods in the OpenAI Agents SDK, and Portkey will properly track and log the streaming interactions.
  </Accordion>

  <Accordion title="How do I filter logs and traces for specific agent runs?">
    Portkey allows you to add custom metadata to your agent runs, which you can then use for filtering. Add fields like `agent_name`, `agent_type`, or `session_id` to easily find and analyze specific agent executions.
  </Accordion>

  <Accordion title="Can I use my own API keys with Portkey?">
    Yes! Portkey uses your own API keys for the various LLM providers. It securely stores them, allowing you to easily manage and rotate keys without changing your code.
  </Accordion>
</AccordionGroup>

## Resources

<CardGroup cols="3">
  <Card title="OpenAI Agents Docs" href="https://openai.github.io/openai-agents-python/">
    <p>Official OpenAI Agents SDK documentation</p>
  </Card>

  <Card title="Agent Examples" href="https://github.com/openai/openai-agents-python/tree/main/examples">
    <p>Example implementations for various use cases</p>
  </Card>

  <Card title="Book a Demo" href="https://portkey.sh/openai-agents">
    <p>Get personalized guidance on implementing this integration</p>
  </Card>
</CardGroup>
