Skip to content
agentgateway has joined the Agentic AI Foundation — Learn more

For the complete documentation index, see llms.txt. Markdown versions of all docs pages are available by appending .md to any docs URL.

OpenAI

Verified : Code examples on this page have been automatically tested and verified.
Page as Markdown

Route agentgateway LLM traffic to OpenAI’s GPT models.

Configure OpenAI as an LLM provider in agentgateway.

Configuration

You can add the model in the UI or in your configuration file.

To add the model in the UI, follow these steps. The steps create the same model as the Config file tab.

  1. Set your API key in the OPENAI_API_KEY environment variable. The UI checks that the variable exists when you save the model.

    export OPENAI_API_KEY='<your-api-key>'
  2. Create a configuration file with an empty llm section, and start agentgateway in the same terminal. Without an llm section, the UI does not show the LLM > Models page.

    cat > config.yaml <<'EOF'
    # yaml-language-server: $schema=https://agentgateway.dev/schema/config
    llm:
      models: []
    EOF
    agentgateway -f config.yaml
  3. Open LLM > Models, such as http://localhost:15000/ui/llm/models, and click Add model.

  4. From the Provider dropdown, select OpenAI.

  5. Keep the default openai/* in the Incoming model match field.

  6. For the Provider API key, select Env var, and enter OPENAI_API_KEY.

  7. For Outgoing model, keep Strip openai/. This option removes the openai/ prefix before the request is forwarded. To send every request to one model instead, select Explicit, and enter the model name. This option sets params.model.

    Add model drawer with OpenAI selected as the provider, openai/* as the incoming model match, and OPENAI_API_KEY as the environment variable for the provider API key
    Add model drawer with OpenAI selected as the provider, openai/* as the incoming model match, and OPENAI_API_KEY as the environment variable for the provider API key
  8. Click Save model.

The UI writes the provider as openai instead of openAI. Agentgateway accepts both values.

Whether the UI can save depends on your storage mode. For more information, see Save changes from the UI.

Send Decisions API requests to /v1/decisions. When responses include OpenAI usage fields, LLM telemetry records the model and token usage. Guardrails do not apply to these requests.

For supported providers, configuration, and examples, see Decisions.

Note

For advanced routing scenarios that require path-based routing or custom endpoints, use the gateways and routes configuration format. See the Routing-based configuration guide for more information.

Note

To connect Codex to agentgateway, see the Codex integration page.

Was this page helpful?
Agentgateway assistant

Ask me anything about agentgateway configuration, features, or usage.

Note: AI-generated content might contain errors; please verify and test all returned information.

Tip: one topic per conversation gives the best results. Use the + button in the chat header to start a new conversation.

Switching topics? Starting a new conversation improves accuracy.
↑↓ navigate ↵ select esc dismiss

What could be improved?

Your feedback helps us improve assistant answers and identify docs gaps we should fix.

Need more help? Join us on Discord: https://discord.gg/y9efgEmppm

Want to use your own agent? Add the Solo MCP server to query our docs directly. Get started here: https://search.solo.io/.