Gateway
OpenAI sohbet tamamlamaları
OpenClaw'ın Gateway'i küçük bir OpenAI uyumlu Chat Completions uç noktası sunabilir.
Bu uç nokta varsayılan olarak devre dışıdır. Önce yapılandırmada etkinleştirin.
POST /v1/chat/completions- Gateway ile aynı bağlantı noktası (WS + HTTP multiplex):
http://<gateway-host>:<port>/v1/chat/completions
Gateway'in OpenAI uyumlu HTTP yüzeyi etkinleştirildiğinde şunları da sunar:
GET /v1/modelsGET /v1/models/{id}POST /v1/embeddingsPOST /v1/responses
Arka planda istekler normal bir Gateway agent çalıştırması olarak yürütülür (openclaw agent ile aynı kod yolu), bu nedenle yönlendirme/izinler/yapılandırma Gateway'inizle eşleşir.
Kimlik doğrulama
Gateway kimlik doğrulama yapılandırmasını kullanır.
Yaygın HTTP kimlik doğrulama yolları:
- paylaşılan gizli anahtar kimlik doğrulaması (
gateway.auth.mode="token"veya"password"):Authorization: Bearer <token-or-password> - güvenilir kimlik taşıyan HTTP kimlik doğrulaması (
gateway.auth.mode="trusted-proxy"): yapılandırılmış kimlik farkındalığı olan proxy üzerinden yönlendirin ve gerekli kimlik başlıklarını eklemesine izin verin - özel giriş açık kimlik doğrulaması (
gateway.auth.mode="none"): kimlik doğrulama başlığı gerekmez
Notlar:
gateway.auth.mode="token"olduğundagateway.auth.token(veyaOPENCLAW_GATEWAY_TOKEN) kullanın.gateway.auth.mode="password"olduğundagateway.auth.password(veyaOPENCLAW_GATEWAY_PASSWORD) kullanın.gateway.auth.mode="trusted-proxy"olduğunda HTTP isteği yapılandırılmış güvenilir bir proxy kaynağından gelmelidir; aynı ana makinedeki local loopback proxy'leri açıkçagateway.auth.trustedProxy.allowLoopback = truegerektirir.gateway.auth.rateLimityapılandırılmışsa ve çok fazla kimlik doğrulama hatası oluşursa uç noktaRetry-Afterile birlikte429döndürür.
Güvenlik sınırı (önemli)
Bu uç noktayı gateway örneği için tam operatör erişimli bir yüzey olarak ele alın.
- Buradaki HTTP bearer kimlik doğrulaması dar bir kullanıcı başına kapsam modeli değildir.
- Bu uç nokta için geçerli bir Gateway token/parolası, sahip/operatör kimlik bilgisi gibi ele alınmalıdır.
- İstekler, güvenilir operatör eylemleriyle aynı kontrol düzlemi agent yolundan geçer.
- Bu uç noktada ayrı bir sahip olmayan/kullanıcı başına araç sınırı yoktur; bir çağıran burada Gateway kimlik doğrulamasını geçtikten sonra OpenClaw bu çağıranı bu gateway için güvenilir operatör olarak ele alır.
- Paylaşılan gizli anahtar kimlik doğrulama modlarında (
tokenvepassword), çağıran daha dar birx-openclaw-scopesbaşlığı gönderse bile uç nokta normal tam operatör varsayılanlarını geri yükler. - Güvenilir kimlik taşıyan HTTP modları (örneğin güvenilir proxy kimlik doğrulaması veya
gateway.auth.mode="none") mevcut olduğundax-openclaw-scopesdeğerini dikkate alır, aksi halde normal operatör varsayılan kapsam kümesine döner. - Hedef agent ilkesi hassas araçlara izin veriyorsa bu uç nokta bunları kullanabilir.
- Bu uç noktayı yalnızca local loopback/Tailscale ağı/özel giriş üzerinde tutun; doğrudan herkese açık internete açmayın.
Kimlik doğrulama matrisi:
gateway.auth.mode="token"veya"password"+Authorization: Bearer ...- paylaşılan gateway operatör gizli anahtarına sahip olunduğunu kanıtlar
- daha dar
x-openclaw-scopesdeğerlerini yok sayar - tam varsayılan operatör kapsam kümesini geri yükler:
operator.admin,operator.approvals,operator.pairing,operator.read,operator.talk.secrets,operator.write - bu uç noktadaki sohbet turlarını sahip-gönderici turları olarak ele alır
- güvenilir kimlik taşıyan HTTP modları (örneğin güvenilir proxy kimlik doğrulaması veya özel girişte
gateway.auth.mode="none")- dıştaki bir güvenilir kimliği veya dağıtım sınırını doğrular
- başlık mevcut olduğunda
x-openclaw-scopesdeğerini dikkate alır - başlık yoksa normal operatör varsayılan kapsam kümesine döner
- yalnızca çağıran kapsamları açıkça daraltıp
operator.admindeğerini çıkardığında sahip semantiğini kaybeder
Bkz. Güvenlik ve Uzaktan erişim.
Agent öncelikli model sözleşmesi
OpenClaw, OpenAI model alanını ham sağlayıcı model kimliği olarak değil, bir agent hedefi olarak ele alır.
model: "openclaw"yapılandırılmış varsayılan agent'a yönlendirir.model: "openclaw/default"de yapılandırılmış varsayılan agent'a yönlendirir.model: "openclaw/<agentId>"belirli bir agent'a yönlendirir.
İsteğe bağlı istek başlıkları:
x-openclaw-model: <provider/model-or-bare-id>seçili agent için arka uç modelini geçersiz kılar.x-openclaw-agent-id: <agentId>uyumluluk geçersiz kılması olarak desteklenmeye devam eder.x-openclaw-session-key: <sessionKey>oturum yönlendirmesini tamamen kontrol eder.x-openclaw-message-channel: <channel>kanal farkındalıklı prompt'lar ve ilkeler için sentetik giriş kanalı bağlamını ayarlar.
Uyumluluk takma adları hâlâ kabul edilir:
model: "openclaw:<agentId>"model: "agent:<agentId>"
Uç noktayı etkinleştirme
gateway.http.endpoints.chatCompletions.enabled değerini true olarak ayarlayın:
{
gateway: {
http: {
endpoints: {
chatCompletions: { enabled: true },
},
},
},
}
Uç noktayı devre dışı bırakma
gateway.http.endpoints.chatCompletions.enabled değerini false olarak ayarlayın:
{
gateway: {
http: {
endpoints: {
chatCompletions: { enabled: false },
},
},
},
}
Oturum davranışı
Varsayılan olarak uç nokta istek başına durumsuzdur (her çağrıda yeni bir oturum anahtarı oluşturulur).
İstek bir OpenAI user dizesi içeriyorsa Gateway bundan kararlı bir oturum anahtarı türetir; böylece tekrarlanan çağrılar bir agent oturumunu paylaşabilir.
Bu yüzey neden önemlidir
Bu, kendi barındırılan frontend'ler ve araçlar için en yüksek kaldıraçlı uyumluluk kümesidir:
- Çoğu Open WebUI, LobeChat ve LibreChat kurulumu
/v1/modelsbekler. - Birçok RAG sistemi
/v1/embeddingsbekler. - Mevcut OpenAI sohbet istemcileri genellikle
/v1/chat/completionsile başlayabilir. - Daha agent yerel istemciler giderek daha fazla
/v1/responsestercih eder.
Model listesi ve agent yönlendirme
`/v1/models` ne döndürür?
Bir OpenClaw agent hedef listesi.
Döndürülen kimlikler openclaw, openclaw/default ve openclaw/<agentId> girdileridir.
Bunları doğrudan OpenAI model değerleri olarak kullanın.
`/v1/models` agent'ları mı yoksa alt agent'ları mı listeler?
Arka uç sağlayıcı modellerini veya alt agent'ları değil, üst düzey agent hedeflerini listeler.
Alt agent'lar dahili yürütme topolojisi olarak kalır. Sözde modeller olarak görünmezler.
`openclaw/default` neden dahil edilir?
openclaw/default, yapılandırılmış varsayılan agent için kararlı takma addır.
Bu, gerçek varsayılan agent kimliği ortamlar arasında değişse bile istemcilerin öngörülebilir tek bir kimliği kullanmaya devam edebileceği anlamına gelir.
Arka uç modelini nasıl geçersiz kılarım?
x-openclaw-model kullanın.
Örnekler:
x-openclaw-model: openai/gpt-5.4
x-openclaw-model: gpt-5.5
Bunu atladığınızda seçili agent normal yapılandırılmış model seçimiyle çalışır.
Embeddings bu sözleşmeye nasıl uyar?
/v1/embeddings aynı agent hedefi model kimliklerini kullanır.
model: "openclaw/default" veya model: "openclaw/<agentId>" kullanın.
Belirli bir embedding modeline ihtiyacınız olduğunda bunu x-openclaw-model içinde gönderin.
Bu başlık olmadan istek, seçili agent'ın normal embedding kurulumuna aktarılır.
Akış (SSE)
Server-Sent Events (SSE) almak için stream: true ayarlayın:
Content-Type: text/event-stream- Her olay satırı
data: <json>biçimindedir - Akış
data: [DONE]ile biter
Open WebUI hızlı kurulum
Temel bir Open WebUI bağlantısı için:
- Temel URL:
http://127.0.0.1:18789/v1 - macOS üzerinde Docker temel URL'si:
http://host.docker.internal:18789/v1 - API anahtarı: Gateway bearer token'ınız
- Model:
openclaw/default
Beklenen davranış:
GET /v1/models,openclaw/defaultdeğerini listelemelidir- Open WebUI, sohbet modeli kimliği olarak
openclaw/defaultkullanmalıdır - Bu agent için belirli bir arka uç sağlayıcı/model istiyorsanız agent'ın normal varsayılan modelini ayarlayın veya
x-openclaw-modelgönderin
Hızlı duman testi:
curl -sS http://127.0.0.1:18789/v1/models \
-H 'Authorization: Bearer YOUR_TOKEN'
Bu openclaw/default döndürürse çoğu Open WebUI kurulumu aynı temel URL ve token ile bağlanabilir.
Örnekler
Akışsız:
curl -sS http://127.0.0.1:18789/v1/chat/completions \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-d '{
"model": "openclaw/default",
"messages": [{"role":"user","content":"hi"}]
}'
Akışlı:
curl -N http://127.0.0.1:18789/v1/chat/completions \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-H 'x-openclaw-model: openai/gpt-5.4' \
-d '{
"model": "openclaw/research",
"stream": true,
"messages": [{"role":"user","content":"hi"}]
}'
Modelleri listeleme:
curl -sS http://127.0.0.1:18789/v1/models \
-H 'Authorization: Bearer YOUR_TOKEN'
Bir modeli getirme:
curl -sS http://127.0.0.1:18789/v1/models/openclaw%2Fdefault \
-H 'Authorization: Bearer YOUR_TOKEN'
Embeddings oluşturma:
curl -sS http://127.0.0.1:18789/v1/embeddings \
-H 'Authorization: Bearer YOUR_TOKEN' \
-H 'Content-Type: application/json' \
-H 'x-openclaw-model: openai/text-embedding-3-small' \
-d '{
"model": "openclaw/default",
"input": ["alpha", "beta"]
}'
Notlar:
/v1/models, ham sağlayıcı katalogları değil OpenClaw agent hedeflerini döndürür.openclaw/defaulther zaman mevcuttur; böylece kararlı tek bir kimlik ortamlar arasında çalışır.- Arka uç sağlayıcı/model geçersiz kılmaları OpenAI
modelalanında değil,x-openclaw-modeliçinde olmalıdır. /v1/embeddings,inputdeğerini dize veya dize dizisi olarak destekler.