OpenAI sohbet tamamlama işlemleri

Documentation Index

Fetch the complete documentation index at: https://docs.openclaw.ai/llms.txt

Use this file to discover all available pages before exploring further.

• POST /v1/chat/completions
• Gateway ile aynı port (WS + HTTP çoklama): http://<gateway-host>:<port>/v1/chat/completions

• GET /v1/models
• GET /v1/models/{id}
• POST /v1/embeddings
• POST /v1/responses

​

Kimlik doğrulama

• paylaşılan gizli 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ıklı 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

• gateway.auth.mode="token" olduğunda gateway.auth.token (veya OPENCLAW_GATEWAY_TOKEN) kullanın.
• gateway.auth.mode="password" olduğunda gateway.auth.password (veya OPENCLAW_GATEWAY_PASSWORD) kullanın.
• gateway.auth.mode="trusted-proxy" olduğunda HTTP isteği yapılandırılmış bir güvenilir proxy kaynağından gelmelidir; aynı ana makinedeki loopback proxy’leri açıkça gateway.auth.trustedProxy.allowLoopback = true gerektirir.
• gateway.auth.rateLimit yapılandırılmışsa ve çok fazla kimlik doğrulama hatası oluşursa uç nokta Retry-After ile 429 döndürür.

​

Güvenlik sınırı (önemli)

• Buradaki HTTP bearer kimlik doğrulaması dar kapsamlı, kullanıcı başına bir 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 ajan 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 o çağıranı bu gateway için güvenilir operatör olarak ele alır.
• Paylaşılan gizli kimlik doğrulama modları (token ve password) için, çağıran daha dar bir x-openclaw-scopes baş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") varsa x-openclaw-scopes değerini dikkate alır, yoksa normal operatör varsayılan kapsam kümesine geri döner.
• Hedef ajan ilkesi hassas araçlara izin veriyorsa bu uç nokta onları kullanabilir.
• Bu uç noktayı yalnızca loopback/tailnet/özel giriş üzerinde tutun; doğrudan genel internete açmayın.

• gateway.auth.mode="token" veya "password" + Authorization: Bearer ...
  • paylaşılan gateway operatör sırrına sahip olunduğunu kanıtlar
  • daha dar x-openclaw-scopes değ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 dönüşlerini sahip-gönderen dönüşleri 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-scopes değerini dikkate alır
  • başlık yoksa normal operatör varsayılan kapsam kümesine geri döner
  • yalnızca çağıran kapsamları açıkça daraltıp operator.admin değerini atladığında sahip semantiğini kaybeder

​

Ajan öncelikli model sözleşmesi

• model: "openclaw" yapılandırılmış varsayılan ajana yönlendirir.
• model: "openclaw/default" de yapılandırılmış varsayılan ajana yönlendirir.
• model: "openclaw/<agentId>" belirli bir ajana yönlendirir.

• x-openclaw-model: <provider/model-or-bare-id> seçilen ajan 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ı istemler ve ilkeler için sentetik giriş kanalı bağlamını ayarlar.

• model: "openclaw:<agentId>"
• model: "agent:<agentId>"

​

Uç noktayı etkinleştirme

{
  gateway: {
    http: {
      endpoints: {
        chatCompletions: { enabled: true },
      },
    },
  },
}

​

Uç noktayı devre dışı bırakma

{
  gateway: {
    http: {
      endpoints: {
        chatCompletions: { enabled: false },
      },
    },
  },
}

​

Oturum davranışı

​

Bu yüzey neden önemlidir?

• Çoğu Open WebUI, LobeChat ve LibreChat kurulumu /v1/models bekler.
• Birçok RAG sistemi /v1/embeddings bekler.
• Mevcut OpenAI sohbet istemcileri genellikle /v1/chat/completions ile başlayabilir.
• Daha ajan-yerel istemciler giderek daha fazla /v1/responses tercih eder.

​

Model listesi ve ajan yönlendirmesi

​

Akış (SSE)

• Content-Type: text/event-stream
• Her olay satırı data: <json> biçimindedir
• Akış data: [DONE] ile biter

​

Sohbet aracı sözleşmesi

​

Desteklenen istek alanları

• tools: { "type": "function", "function": { ... } } dizisi
• tool_choice: "auto", "none"
• messages[*].role: "tool" takip dönüşleri
• araç sonuçlarını önceki bir araç çağrısına geri bağlamak için messages[*].tool_call_id
• max_completion_tokens: sayı; toplam tamamlama token’ları için çağrı başına sınır (akıl yürütme token’ları dahil). Güncel OpenAI Sohbet Tamamlamaları alan adı; hem max_completion_tokens hem de max_tokens gönderildiğinde tercih edilir.
• max_tokens: sayı; geriye dönük uyumluluk için kabul edilen eski takma ad. max_completion_tokens de mevcut olduğunda yok sayılır.

​

Desteklenmeyen varyantlar

• dizi olmayan tools
• işlev olmayan araç girdileri
• eksik tool.function.name
• allowed_tools ve custom gibi tool_choice varyantları
• tool_choice: "required" (henüz çalışma zamanında zorlanmıyor; katı zorlama uygulandığında desteklenecek)
• tool_choice: { "type": "function", "function": { "name": "..." } } (required ile aynı gerekçe)
• sağlanan tools ile eşleşmeyen tool_choice.function.name değerleri

​

Akışsız araç yanıtı şekli

• choices[0].finish_reason = "tool_calls"
• Şunları içeren choices[0].message.tool_calls[] girdileri:
  • id
  • type: "function"
  • function.name
  • function.arguments (JSON dizesi)

​

Akışlı araç yanıtı şekli

• ilk asistan rol deltası
• isteğe bağlı asistan yorumu deltaları
• araç kimliği ve argüman parçaları taşıyan bir veya daha fazla delta.tool_calls parçası
• finish_reason: "tool_calls" içeren son parça
• data: [DONE]

​

Araç takip döngüsü

• önceki asistan araç-çağrı mesajı
• eşleşen tool_call_id içeren bir veya daha fazla role: "tool" mesajı

​

Open WebUI hızlı kurulumu

• 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

• GET /v1/models openclaw/default listesini göstermelidir
• Open WebUI sohbet model kimliği olarak openclaw/default kullanmalıdır
• Bu ajan için belirli bir arka uç sağlayıcı/model istiyorsanız ajanın normal varsayılan modelini ayarlayın veya x-openclaw-model gönderin

curl -sS http://127.0.0.1:18789/v1/models \
  -H 'Authorization: Bearer YOUR_TOKEN'

​

Örnekler

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"}]
  }'

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"}]
  }'

curl -sS http://127.0.0.1:18789/v1/models \
  -H 'Authorization: Bearer YOUR_TOKEN'

curl -sS http://127.0.0.1:18789/v1/models/openclaw%2Fdefault \
  -H 'Authorization: Bearer YOUR_TOKEN'

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"]
  }'

• /v1/models ham sağlayıcı kataloglarını değil, OpenClaw aracı hedeflerini döndürür.
• openclaw/default her zaman mevcuttur; böylece tek bir kararlı kimlik ortamlar arasında çalışır.
• Arka uç sağlayıcı/model geçersiz kılmaları, OpenAI model alanında değil x-openclaw-model içinde yer almalıdır.
• /v1/embeddings, input için bir dize veya dize dizisini destekler.

​

İlgili

• Yapılandırma başvurusu
• OpenAI