OpenAI provider

You can proxy requests to OpenAI AI models through AI Gateway by creating AI Model Provider and AI Model entities. This reference documents all supported AI capabilities, configuration requirements, and provider-specific details needed for proper integration.

AI Gateway automatically routes requests to the appropriate OpenAI API endpoints. The following table shows the upstream paths used for each capability.

The following tables show the AI capabilities supported by the OpenAI provider when configuring AI Models.

By default, AI Gateway uses the path templates shown in the tables below (e.g., /chat/completions, /embeddings, etc.). To customize these paths, configure the config.paths field in your AI Model entity. Custom paths take the form {configured_path}/{template_path} — for example, if you set a custom path of /v2, requests to /embeddings would be routed to /v2/embeddings.

Text generation

Support for OpenAI text generation capabilities:

Embeddings

Support for OpenAI embeddings generation:

¹ Use text-embedding-3-small or text-embedding-3-large for dynamic dimensions.

Agentic

Support for OpenAI agent and assistant capabilities:

² Requires header OpenAI-Beta: assistants=v2

Audio

Support for OpenAI audio capabilities (speech synthesis, transcription, and translation):

For requests with large payloads, consider increasing config.max_request_body_size on your AI Model entity to three times the raw binary size.

Supported audio formats, voices, and parameters vary by model. Refer to your provider’s documentation for available options.

Image

Support for OpenAI image generation and editing capabilities:

For requests with large payloads, consider increasing config.max_request_body_size on your AI Model entity to three times the raw binary size.

Supported image sizes and formats vary by model. Refer to your provider’s documentation for allowed dimensions and requirements.

Video

Support for OpenAI video generation capabilities:

For requests with large payloads (video generation), consider increasing config.max_request_body_size on your AI Model entity to three times the raw binary size.

Realtime

Support for OpenAI’s bidirectional streaming for realtime applications:

Realtime processing uses WebSocket protocol (ws/wss). This protocol is automatically enabled when you configure your AI Model with the realtime capability.

³ For requests to OpenAI realtime API, include the header OpenAI-Beta: realtime=v1.

Batches

Support for OpenAI batch processing capabilities:

Batches are configured on a separate AI Model with type: "api", distinct from regular models that handle synchronous capabilities like generate and embeddings. Create a dedicated AI Model exclusively for batches and files, as each model must be either a regular model or an API model, not both.

Files

Support for OpenAI file management capabilities:

Batches are configured on a separate AI Model with type: "api", distinct from regular models that handle synchronous capabilities like generate and embeddings. Create a dedicated AI Model exclusively for batches and files, as each model must be either a regular model or an API model, not both.## OpenAI base URL

The base URL is https://api.openai.com:443/{capability_path}. The {capability_path} is determined by the AI capability.

AI Gateway uses this URL automatically. You only need to configure a URL if you’re using a self-hosted or OpenAI-compatible endpoint, in which case set the upstream_url option in your AI Model configuration.

To use OpenAI with AI Gateway, configure a new AI Model Provider. You can then access supported AI Models from OpenAI.

Here’s a minimal configuration for chat completions:

curl -X POST https://{region}.api.konghq.com/v1/ai-gateways/{AIGatewayId}/model-providers \
    --header "accept: application/json" \
    --header "Content-Type: application/json" \
    --header "Authorization: Bearer $KONNECT_TOKEN" \
    --data '
    {
      "display_name": "OpenAI Production",
      "name": "my-openai-account",
      "type": "openai",
      "config": {
        "auth": {
          "type": "basic",
          "headers": [
            {
              "name": "Authorization",
              "value": "'$OPENAI_API_KEY'"
            }
          ]
        }
      }
    }
    '

ai_gateway_model_providers:
  - ref: my-openai-account
    ai_gateway: !lookup {id: !env AI_GATEWAY_ID}
    display_name: OpenAI Production
    name: my-openai-account
    type: openai
    config:
      auth:
        type: basic
        headers:
        - name: Authorization
          value: !secret {source: !env OPENAI_API_KEY}