İstekler normal bir Gateway ajan çalıştırması olarak yürütülür (
openclaw agent ile aynı kod yolu); dolayısıyla yönlendirme, izinler ve yapılandırma Gateway’inizle eşleşir.
Uç noktayı etkinleştirme
enabled: false olarak ayarlayın (veya bu ayarı atlayın).
Güvenlik sınırı (önemli)
Bu uç noktayı gateway örneğine tam operatör erişimi olarak değerlendirin:- Bu uç nokta için geçerli bir Gateway belirteci/parolası, dar kapsamlı bir kullanıcı başına yetki değil, sahip/operatör kimlik bilgisiyle eşdeğerdir.
- İstekler, güvenilir operatör eylemleriyle aynı kontrol düzlemi ajan yolundan geçer; dolayısıyla hedef ajanın politikası hassas araçlara izin veriyorsa bu uç nokta bunları kullanabilir.
- Yalnızca geri döngü/tailnet/özel giriş üzerinde tutun. Genel internete açmayın.
Bkz. Operatör kapsamları, Güvenlik ve Uzaktan erişim.
Kimlik doğrulama
Gateway kimlik doğrulama yapılandırmasını kullanır (bu modun ayrıntıları için bkz. Güvenilir proxy kimlik doğrulaması):
Notlar:
- Bir
trusted-proxygateway üzerinde proxy’yi atlayan aynı ana makine çağıranları doğrudangateway.auth.password/OPENCLAW_GATEWAY_PASSWORDkullanımına geri dönebilir. Herhangi birForwarded,X-Forwarded-*veyaX-Real-IPüst bilgisi kanıtı, isteğin bunun yerine güvenilir proxy yolunda kalmasını sağlar. gateway.auth.rateLimityapılandırılmışsa ve çok fazla kimlik doğrulama girişimi başarısız olursa uç nokta,Retry-Afterüst bilgisiyle429döndürür.
Bu uç nokta ne zaman kullanılmalı?
- Entegrasyonunuz aynı gateway için yalnızca başka bir operatör/istemci yüzeyiyse yeni bir yerleşik kanal eklemek yerine bunu tercih edin.
- Uzak bir gateway’e doğrudan bağlanan yerel mobil istemcilerde, cihazın paylaşılan bir HTTP belirtecine/parolasına ihtiyaç duymaması için eşleştirilmiş cihaz önyükleme/cihaz belirteci akışıyla WebChat veya Gateway Protokolünü tercih edin.
- Kendi kullanıcıları, odaları, Webhook teslimatı veya giden aktarımı olan harici bir mesajlaşma ağıyla entegrasyon yaparken bunun yerine bir kanal Plugin’i oluşturun. Bkz. Plugin oluşturma.
Ajan öncelikli model sözleşmesi
OpenClaw, OpenAImodel alanını ham sağlayıcı model kimliği olarak değil, bir ajan hedefi olarak değerlendirir.
İsteğe bağlı istek üst bilgileri:
/v1/models, arka uç sağlayıcı modellerini veya alt ajanları değil, üst düzey ajan hedeflerini (openclaw, openclaw/default, openclaw/<agentId>) listeler; alt ajanlar dahili yürütme topolojisi olarak kalır. x-openclaw-model değerini atlarsanız seçilen ajan normal yapılandırılmış modeliyle çalışır.
/v1/embeddings, aynı ajan hedefi model kimliklerini kullanır. Belirli bir gömme modeli seçmek için x-openclaw-model gönderin (paylaşılan gizli bilgi çağıranından veya operator.admin kapsamına sahip kimlik taşıyan bir çağırandan); aksi takdirde istek, seçilen ajanın normal gömme kurulumunu kullanır.
Oturum davranışı
Uç nokta varsayılan olarak istek başına durumsuzdur (her çağrıda yeni bir oturum anahtarı oluşturulur). İstek bir OpenAIuser dizesi içeriyorsa Gateway, yinelenen çağrıların bir ajan oturumunu paylaşabilmesi için bundan kararlı bir oturum anahtarı türetir. Özel uygulamalarda konuşma dizisi başına aynı user değerini yeniden kullanın; birden fazla konuşmanın/cihazın tek bir OpenClaw oturumunu paylaşmasını istemiyorsanız hesap düzeyindeki tanımlayıcılardan kaçının. x-openclaw-session-key değerini yalnızca birden fazla istemci/dizi arasında açık yönlendirme denetimine ihtiyaç duyduğunuzda, yukarıdaki ayrılmış ad alanlarından kaçınan uygulama sahipli anahtarlarla kullanın.
İstek sınırları
Uç nokta, istek gövdesi başına 20 MB, en son kullanıcı iletisinden 8image_url
parçası ve toplam 20 MB kodu çözülmüş görüntü
verisi için yerleşik sınırlar kullanır. Görüntü kaynağı politikası
gateway.http.endpoints.chatCompletions.images altında yapılandırılabilir olmaya devam eder:
HEIC/HEIF
image_url kaynakları kabul edilir ve paylaşılan OpenClaw görüntü işleyicisi (Rastermill) üzerinden sağlayıcıya teslim edilmeden önce JPEG’e dönüştürülür; bu işleyici, harici kodek desteği gerektiren biçimler için sistem dönüştürücüsüne (sips, ImageMagick, GraphicsMagick veya ffmpeg) geri döner.
Güvenlik notu: Bir ana makine adının izin verilenler listesine eklenmesi, özel/dahili IP engellemesini aşmaz. İnternete açık gateway’lerde uygulama düzeyindeki korumalara ek olarak ağ çıkış kontrolleri uygulayın. Bkz. Güvenlik.
Sohbet aracı sözleşmesi
/v1/chat/completions, yaygın OpenAI Chat istemcileriyle uyumlu bir işlev aracı alt kümesini destekler.
Desteklenen istek alanları
Tüm örnekleme ve token üst sınırı alanları aynı ajan akış parametresi kanalını kullanır ve mümkün olan en iyi şekilde iletilir:
- Token üst sınırı: kablo alanı adı sağlayıcı aktarımı tarafından seçilir: OpenAI ailesi uç noktaları için
max_completion_tokens, yalnızca eski adı kabul eden sağlayıcılar (Mistral, Chutes) içinmax_tokens. stop, aktarımın durdurma alanına eşlenir: Chat Completions arka uçları içinstop, Anthropic içinstop_sequences. OpenAI Responses API’sinde durdurma parametresi bulunmadığındanstop, Responses tabanlı modellere uygulanmaz.- ChatGPT tabanlı Codex Responses arka ucu sabit sunucu tarafı örnekleme kullanır ve istek bu arka uca ulaşmadan önce
temperature/top_palanlarını (max_output_tokens,metadata,prompt_cache_retention,service_tierile birlikte) kaldırır.
Desteklenmeyen varyantlar
Şunlar için400 invalid_request_error döndürür:
- dizi olmayan
tools, işlev olmayan araç girdileri veya eksiktool.function.name allowed_toolsvecustomgibitool_choicevaryantları- sağlanan bir araçla eşleşmeyen
tool_choice.function.namedeğerleri
tool_choice: "required" ve işleve sabitlenmiş tool_choice için uç nokta, sunulan istemci işlev aracı kümesini daraltır, çalışma zamanına yanıt vermeden önce bir istemci aracını çağırması talimatını verir ve ajan yanıtında eşleşen yapılandırılmış bir istemci aracı çağrısı yoksa hata verir. Bu, tüm dahili OpenClaw ajan araçlarına değil, çağıranın sağladığı HTTP tools listesine uygulanır.
Akışsız araç yanıtı biçimi
Ajan araçları çağırdığında yanıt şunları kullanır:choices[0].finish_reason = "tool_calls"id,type: "function",function.name,function.arguments(JSON dizesi) içerenchoices[0].message.tool_calls[]girdileri- Araç çağrısından önce
choices[0].message.contentiçindeki asistan açıklaması (boş olabilir)
Akışlı araç yanıtı biçimi
stream: true olduğunda araç çağrıları artımlı SSE parçaları olarak gelir: ilk asistan rolü deltası, isteğe bağlı asistan açıklaması deltaları, araç kimliğini ve bağımsız değişken parçalarını taşıyan bir veya daha fazla delta.tool_calls parçası, ardından finish_reason: "tool_calls" ve data: [DONE] içeren son bir parça.
stream_options.include_usage=true ise [DONE] öncesinde sonda bir kullanım parçası yayınlanır.
Araç takip döngüsü
tool_calls alındıktan sonra istenen işlevleri yürütün ve önceki asistan araç çağrısı iletisini ve eşleşen tool_call_id değerlerine sahip bir veya daha fazla role: "tool" iletisini içeren bir takip isteği gönderin. Bu işlem, nihai yanıtı üretmek için aynı ajan akıl yürütme döngüsünü sürdürür.
Akış (SSE)
Server-Sent Events almak içinstream: true ayarlayın:
Content-Type: text/event-stream- Her olay satırı
data: <json>biçimindedir - Akış
data: [DONE]ile sona erer
Open WebUI hızlı kurulumu
- Temel URL:
http://127.0.0.1:18789/v1 - macOS’ta Docker temel URL’si:
http://host.docker.internal:18789/v1 - API anahtarı: Gateway bearer token’ınız
- Model:
openclaw/default
GET /v1/models, openclaw/default öğesini listeler ve Open WebUI bunu sohbet modeli kimliği olarak kullanır. Belirli bir arka uç sağlayıcısı/modeli için ajanın normal varsayılan modelini ayarlayın veya x-openclaw-model gönderin (paylaşılan gizli anahtar kullanan çağıran ya da operator.admin değerine sahip, kimlik taşıyan çağıran).
Hızlı duman testi:
openclaw/default döndürürse çoğu Open WebUI kurulumu aynı temel URL ve token ile bağlanabilir.
Örnekler
Tek bir uygulama konuşması için kararlı oturum:user değerini yeniden kullanın.
Akışsız:
/v1/embeddings, dize veya dize dizisi olarak input destekler.