OpenAI

OpenAI menyediakan API pengembang untuk model GPT, dan Codex juga tersedia sebagai agen coding paket ChatGPT melalui klien Codex OpenAI. OpenClaw menjaga permukaan tersebut tetap terpisah agar konfigurasi tetap dapat diprediksi.

OpenClaw menggunakan openai/* sebagai rute model OpenAI kanonis. Giliran agen tertanam pada model OpenAI berjalan melalui runtime server aplikasi Codex native secara default; autentikasi kunci API OpenAI langsung tetap tersedia untuk permukaan OpenAI non-agen seperti gambar, embedding, ucapan, dan realtime.

• Model agen - model openai/* melalui runtime Codex; masuk dengan autentikasi openai-codex untuk penggunaan langganan ChatGPT/Codex, atau konfigurasikan profil kunci API openai-codex ketika Anda sengaja menginginkan autentikasi kunci API.
• API OpenAI non-agen - akses OpenAI Platform langsung dengan penagihan berbasis penggunaan melalui OPENAI_API_KEY atau onboarding kunci API OpenAI.
• Konfigurasi lama - referensi model openai-codex/* diperbaiki oleh openclaw doctor --fix menjadi openai/* plus runtime Codex.

OpenAI secara eksplisit mendukung penggunaan OAuth langganan di alat dan alur kerja eksternal seperti OpenClaw.

Penyedia, model, runtime, dan channel adalah lapisan terpisah. Jika label tersebut tercampur, baca Runtime agen sebelum mengubah konfigurasi.

# Pilihan cepat

# Peta penamaan

Nama-nama ini mirip tetapi tidak dapat dipertukarkan:

Ini berarti konfigurasi dapat dengan sengaja berisi referensi model openai/* dan profil autentikasi openai-codex. openclaw doctor --fix menulis ulang referensi model lama openai-codex/* ke rute model OpenAI kanonis.

# Cakupan fitur OpenClaw

# Embedding memori

OpenClaw dapat menggunakan OpenAI, atau endpoint embedding yang kompatibel dengan OpenAI, untuk pengindeksan memory_search dan embedding kueri:

{
  agents: {
    defaults: {
      memorySearch: {
        provider: "openai",
        model: "text-embedding-3-small",
      },
    },
  },
}

Untuk endpoint yang kompatibel dengan OpenAI dan memerlukan label embedding asimetris, atur queryInputType dan documentInputType di bawah memorySearch. OpenClaw meneruskannya sebagai field permintaan input_type khusus penyedia: embedding kueri menggunakan queryInputType; potongan memori terindeks dan pengindeksan batch menggunakan documentInputType. Lihat Referensi konfigurasi memori untuk contoh lengkapnya.

# Memulai

Pilih metode autentikasi yang Anda inginkan dan ikuti langkah penyiapannya.

openclaw onboard --auth-choice openai-api-key

openclaw onboard --openai-api-key "$OPENAI_API_KEY"

openclaw models list --provider openai

{
  env: { OPENAI_API_KEY: "sk-..." },
  agents: { defaults: { model: { primary: "openai/gpt-5.5" } } },
}

{
  env: { OPENAI_API_KEY: "sk-..." },
  agents: { defaults: { model: { primary: "openai/chat-latest" } } },
}

openclaw onboard --auth-choice openai-codex

openclaw models auth login --provider openai-codex

openclaw models auth login --provider openai-codex --device-code

openclaw config set agents.defaults.model.primary openai/gpt-5.5

openclaw models list --provider openai-codex

{
  plugins: { entries: { codex: { enabled: true } } },
  agents: {
    defaults: {
      model: { primary: "openai/gpt-5.5" },
      agentRuntime: { id: "codex" },
    },
  },
}

openclaw models status
openclaw models auth list --provider openai-codex
openclaw config get agents.defaults.model --json
openclaw config get agents.defaults.agentRuntime --json

openclaw models status --agent <id>
openclaw models auth list --agent <id> --provider openai-codex

openclaw doctor --fix
openclaw config validate

openclaw models auth login --provider openai-codex
openclaw models status --probe --probe-provider openai-codex

{
  models: {
    providers: {
      "openai-codex": {
        models: [{ id: "gpt-5.5", contextTokens: 160000 }],
      },
    },
  },
}

# Auth app-server Codex native

Harness app-server Codex native menggunakan referensi model openai/* plus konfigurasi runtime yang dihilangkan atau agentRuntime.id: "codex", tetapi auth-nya tetap berbasis akun. OpenClaw memilih auth dalam urutan ini:

1. Profil auth OpenClaw openai-codex eksplisit yang terikat ke agen.
2. Akun app-server yang ada, seperti login ChatGPT CLI Codex lokal.
3. Hanya untuk peluncuran app-server stdio lokal, CODEX_API_KEY, lalu OPENAI_API_KEY, saat app-server melaporkan tidak ada akun dan masih memerlukan auth OpenAI.

Artinya, login langganan ChatGPT/Codex lokal tidak diganti hanya karena proses gateway juga memiliki OPENAI_API_KEY untuk model OpenAI langsung atau embeddings. Fallback kunci API env hanya untuk jalur stdio lokal tanpa akun; fallback itu tidak dikirim ke koneksi app-server WebSocket. Saat profil Codex gaya langganan dipilih, OpenClaw juga menahan CODEX_API_KEY dan OPENAI_API_KEY dari child app-server stdio yang dijalankan dan mengirim kredensial terpilih melalui RPC login app-server.

# Pembuatan gambar

Plugin openai bawaan mendaftarkan pembuatan gambar melalui tool image_generate. Plugin ini mendukung pembuatan gambar dengan kunci API OpenAI dan pembuatan gambar OAuth Codex melalui referensi model openai/gpt-image-2 yang sama.

{
  agents: {
    defaults: {
      imageGenerationModel: { primary: "openai/gpt-image-2" },
    },
  },
}

gpt-image-2 adalah default untuk pembuatan gambar dari teks OpenAI dan pengeditan gambar. gpt-image-1.5, gpt-image-1, dan gpt-image-1-mini tetap dapat digunakan sebagai pengganti model eksplisit. Gunakan openai/gpt-image-1.5 untuk keluaran PNG/WebP berlatar belakang transparan; API gpt-image-2 saat ini menolak background: "transparent".

Untuk permintaan latar belakang transparan, agen harus memanggil image_generate dengan model: "openai/gpt-image-1.5", outputFormat: "png" atau "webp", dan background: "transparent"; opsi penyedia openai.background yang lebih lama masih diterima. OpenClaw juga melindungi rute OAuth OpenAI publik dan OpenAI Codex dengan menulis ulang permintaan transparan default openai/gpt-image-2 ke gpt-image-1.5; endpoint Azure dan endpoint kompatibel OpenAI kustom mempertahankan nama deployment/model yang dikonfigurasi.

Pengaturan yang sama diekspos untuk run CLI headless:

openclaw infer image generate \
  --model openai/gpt-image-1.5 \
  --output-format png \
  --background transparent \
  --prompt "A simple red circle sticker on a transparent background" \
  --json

Gunakan flag --output-format dan --background yang sama dengan openclaw infer image edit saat memulai dari file input. --openai-background tetap tersedia sebagai alias khusus OpenAI.

Untuk instalasi OAuth Codex, pertahankan referensi openai/gpt-image-2 yang sama. Saat profil OAuth openai-codex dikonfigurasi, OpenClaw menyelesaikan token akses OAuth yang tersimpan dan mengirim permintaan gambar melalui backend Codex Responses. OpenClaw tidak mencoba OPENAI_API_KEY terlebih dahulu atau diam-diam fallback ke kunci API untuk permintaan tersebut. Konfigurasikan models.providers.openai secara eksplisit dengan kunci API, URL dasar kustom, atau endpoint Azure saat Anda menginginkan rute OpenAI Images API langsung. Jika endpoint gambar kustom tersebut berada di alamat LAN/pribadi tepercaya, setel juga browser.ssrfPolicy.dangerouslyAllowPrivateNetwork: true; OpenClaw tetap memblokir endpoint gambar kompatibel OpenAI privat/internal kecuali opt-in ini ada.

Buat:

/tool image_generate model=openai/gpt-image-2 prompt="A polished launch poster for OpenClaw on macOS" size=3840x2160 count=1

Buat PNG transparan:

/tool image_generate model=openai/gpt-image-1.5 prompt="A simple red circle sticker on a transparent background" outputFormat=png background=transparent

Edit:

/tool image_generate model=openai/gpt-image-2 prompt="Preserve the object shape, change the material to translucent glass" image=/path/to/reference.png size=1024x1536

# Pembuatan video

Plugin openai bawaan mendaftarkan pembuatan video melalui tool video_generate.

{
  agents: {
    defaults: {
      videoGenerationModel: { primary: "openai/sora-2" },
    },
  },
}

# Kontribusi prompt GPT-5

OpenClaw menambahkan kontribusi prompt GPT-5 bersama untuk run keluarga GPT-5 lintas penyedia. Ini berlaku berdasarkan id model, sehingga openai/gpt-5.5, referensi lama sebelum perbaikan seperti openai-codex/gpt-5.5, openrouter/openai/gpt-5.5, opencode/gpt-5.5, dan referensi GPT-5 kompatibel lainnya menerima overlay yang sama. Model GPT-4.x yang lebih lama tidak.

Harness Codex native bawaan menggunakan perilaku GPT-5 dan overlay Heartbeat yang sama melalui instruksi developer app-server Codex, sehingga sesi openai/gpt-5.x yang dipaksa melalui agentRuntime.id: "codex" mempertahankan panduan tindak lanjut dan Heartbeat proaktif yang sama meskipun Codex memiliki sisa prompt harness.

Kontribusi GPT-5 menambahkan kontrak perilaku bertag untuk persistensi persona, keamanan eksekusi, disiplin alat, bentuk output, pemeriksaan penyelesaian, dan verifikasi. Perilaku balasan khusus channel dan pesan senyap tetap berada di prompt sistem OpenClaw bersama dan kebijakan pengiriman outbound. Panduan GPT-5 selalu diaktifkan untuk model yang cocok. Lapisan gaya interaksi ramah terpisah dan dapat dikonfigurasi.

{
  agents: {
    defaults: {
      promptOverlays: {
        gpt5: { personality: "friendly" },
      },
    },
  },
}

openclaw config set agents.defaults.promptOverlays.gpt5.personality off

# Suara dan ucapan

{
  messages: {
    tts: {
      providers: {
        openai: { model: "gpt-4o-mini-tts", voice: "coral" },
      },
    },
  },
}

{
  tools: {
    media: {
      audio: {
        models: [
          {
            type: "provider",
            provider: "openai",
            model: "gpt-4o-transcribe",
          },
        ],
      },
    },
  },
}

# Endpoint Azure OpenAI

Provider openai bawaan dapat menargetkan resource Azure OpenAI untuk pembuatan gambar dengan menimpa URL dasar. Pada jalur pembuatan gambar, OpenClaw mendeteksi hostname Azure pada models.providers.openai.baseUrl dan beralih ke bentuk permintaan Azure secara otomatis.

Gunakan Azure OpenAI ketika:

• Anda sudah memiliki langganan, kuota, atau perjanjian enterprise Azure OpenAI
• Anda membutuhkan residensi data regional atau kontrol kepatuhan yang disediakan Azure
• Anda ingin menjaga trafik tetap berada di dalam tenancy Azure yang sudah ada

# Konfigurasi

Untuk pembuatan gambar Azure melalui provider openai bawaan, arahkan models.providers.openai.baseUrl ke resource Azure Anda dan setel apiKey ke kunci Azure OpenAI (bukan kunci OpenAI Platform):

{
  models: {
    providers: {
      openai: {
        baseUrl: "https://<your-resource>.openai.azure.com",
        apiKey: "<azure-openai-api-key>",
      },
    },
  },
}

OpenClaw mengenali suffix host Azure berikut untuk rute pembuatan gambar Azure:

• *.openai.azure.com
• *.services.ai.azure.com
• *.cognitiveservices.azure.com

Untuk permintaan pembuatan gambar pada host Azure yang dikenali, OpenClaw:

• Mengirim header api-key alih-alih Authorization: Bearer
• Menggunakan path berscope deployment (/openai/deployments/{deployment}/...)
• Menambahkan ?api-version=... ke setiap permintaan
• Menggunakan timeout permintaan default 600 detik untuk panggilan pembuatan gambar Azure. Nilai timeoutMs per panggilan tetap menimpa default ini.

URL dasar lain (OpenAI publik, proxy kompatibel OpenAI) mempertahankan bentuk permintaan gambar OpenAI standar.

# Versi API

Setel AZURE_OPENAI_API_VERSION untuk mengunci versi preview atau GA Azure tertentu untuk jalur pembuatan gambar Azure:

export AZURE_OPENAI_API_VERSION="2024-12-01-preview"

Default-nya adalah 2024-12-01-preview ketika variabel belum disetel.

# Nama model adalah nama deployment

Azure OpenAI mengikat model ke deployment. Untuk permintaan pembuatan gambar Azure yang dirutekan melalui provider openai bawaan, field model di OpenClaw harus berupa nama deployment Azure yang Anda konfigurasikan di portal Azure, bukan id model OpenAI publik.

Jika Anda membuat deployment bernama gpt-image-2-prod yang melayani gpt-image-2:

/tool image_generate model=openai/gpt-image-2-prod prompt="A clean poster" size=1024x1024 count=1

Aturan nama deployment yang sama berlaku untuk panggilan pembuatan gambar yang dirutekan melalui provider openai bawaan.

# Ketersediaan regional

Pembuatan gambar Azure saat ini hanya tersedia di sebagian region (misalnya eastus2, swedencentral, polandcentral, westus3, uaenorth). Periksa daftar region Microsoft saat ini sebelum membuat deployment, dan pastikan model tertentu ditawarkan di region Anda.

# Perbedaan parameter

Azure OpenAI dan OpenAI publik tidak selalu menerima parameter gambar yang sama. Azure dapat menolak opsi yang diizinkan OpenAI publik (misalnya nilai background tertentu pada gpt-image-2) atau mengeksposnya hanya pada versi model tertentu. Perbedaan ini berasal dari Azure dan model yang mendasarinya, bukan OpenClaw. Jika permintaan Azure gagal dengan error validasi, periksa set parameter yang didukung oleh deployment dan versi API spesifik Anda di portal Azure.

# Konfigurasi lanjutan

{
  agents: {
    defaults: {
      models: {
        "openai/gpt-5.5": {
          params: { transport: "auto" },
        },
      },
    },
  },
}

// Disable warm-up
{
  agents: {
    defaults: {
      models: {
        "openai/gpt-5.5": {
          params: { openaiWsWarmup: false },
        },
      },
    },
  },
}

{
  agents: {
    defaults: {
      models: {
        "openai/gpt-5.5": { params: { fastMode: true } },
      },
    },
  },
}

{
  agents: {
    defaults: {
      models: {
        "openai/gpt-5.5": { params: { serviceTier: "priority" } },
      },
    },
  },
}

{
  agents: {
    defaults: {
      models: {
        "azure-openai-responses/gpt-5.5": {
          params: { responsesServerCompaction: true },
        },
      },
    },
  },
}

{
  agents: {
    defaults: {
      models: {
        "openai/gpt-5.5": {
          params: {
            responsesServerCompaction: true,
            responsesCompactThreshold: 120000,
          },
        },
      },
    },
  },
}

{
  agents: {
    defaults: {
      models: {
        "openai/gpt-5.5": {
          params: { responsesServerCompaction: false },
        },
      },
    },
  },
}

{
  agents: {
    defaults: {
      embeddedPi: { executionContract: "strict-agentic" },
    },
  },
}

# Terkait