> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ag2.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# OpenAI

[OpenAI](https://openai.com/)'s API and models are fully supported in AG2. You will need an OpenAI account and to create an API key. [See their website for further details](https://openai.com/).

## Installation

<Warning>
  **From version 0.8**: The OpenAI package, `openai`, is not installed by default, install it with the `openai` extra as shown below.
</Warning>

```bash theme={null}
pip install ag2[openai]
```

<Tip>
  If you have been using `autogen` or `ag2`, all you need to do is upgrade it using:

  ```bash theme={null}
  pip install -U autogen[openai]
  ```

  or

  ```bash theme={null}
  pip install -U ag2[openai]
  ```

  as `autogen` and `ag2` are aliases for the same PyPI package.
</Tip>

## LLM Configurations

See the [LLM Configuration](/docs/user-guide/basic-concepts/llm-configuration) for further details on setting an creating an LLM configuration.

The below example of an `OAI_CONFIG_LIST` shows how the OpenAI client class is used by specifying the `api_type` as `openai`.

```python theme={null}
[
    {
        "api_type": "openai",
        "model": "o1",
        "api_key": "your OpenAI Key goes here",
    },
    {
        "api_type": "openai",
        "model": "gpt-4o-mini",
        "api_key": "your OpenAI Key goes here",
    },
    {
        "api_type": "openai",
        "model": "gpt-4o-mini",
        "api_key": "your OpenAI Key goes here",
    }
]
```

As an alternative to the `api_key` key and value in the config, you can set the environment variable `OPENAI_API_KEY` to your OpenAI key.

Linux/Mac:

```bash theme={null}
export OPENAI_API_KEY="your_openai_api_key_here"
```

Windows:

```bash theme={null}
set OPENAI_API_KEY=your_openai_api_key_here
```

## Examples

See the [ConversableAgent example](/docs/user-guide/basic-concepts/conversable-agent) in our [Basic Concepts](/docs/user-guide/basic-concepts/installing-ag2) documentation to see OpenAI's LLMs in use.

<div className="edit-url-container">
  <a className="edit-url" href="https://github.com/ag2ai/ag2/edit/main/website/docs/user-guide/models/openai.mdx" target="_blank"><Icon icon="pen" iconType="solid" size="13px" /> Edit this page</a>
</div>
