Uzupełnienia czatu OpenAI

​

Włączanie punktu końcowego

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

​

Granica bezpieczeństwa (ważne)

• Prawidłowy token lub hasło Gateway dla tego punktu końcowego jest równoważne poświadczeniu właściciela/operatora, a nie wąskiemu zakresowi przypisanemu do użytkownika.
• Żądania przechodzą tą samą ścieżką agenta warstwy sterowania co zaufane działania operatora, więc jeśli zasady agenta docelowego zezwalają na użycie wrażliwych narzędzi, ten punkt końcowy również może z nich korzystać.
• Udostępniaj go wyłącznie przez local loopback, tailnet lub prywatny punkt wejścia. Nie udostępniaj go w publicznym Internecie.

​

Uwierzytelnianie

• Wywołujący z tego samego hosta, którzy omijają proxy w Gateway działającym w trybie trusted-proxy, mogą użyć bezpośrednio gateway.auth.password / OPENCLAW_GATEWAY_PASSWORD. Obecność w nagłówkach jakichkolwiek danych Forwarded, X-Forwarded-* lub X-Real-IP powoduje jednak, że żądanie pozostaje na ścieżce zaufanego proxy.
• Jeśli skonfigurowano gateway.auth.rateLimit i zbyt wiele prób uwierzytelnienia zakończy się niepowodzeniem, punkt końcowy zwraca 429 z nagłówkiem Retry-After.

​

Kiedy używać tego punktu końcowego

• Preferuj go zamiast dodawania nowego wbudowanego kanału, jeśli integracja jest tylko kolejnym interfejsem operatora/klienta dla tego samego Gateway.
• W przypadku natywnych klientów mobilnych łączących się bezpośrednio ze zdalnym Gateway preferuj WebChat lub protokół Gateway z przepływem inicjalizacji sparowanego urządzenia i tokenu urządzenia, aby urządzenie nie potrzebowało współdzielonego tokenu ani hasła HTTP.
• Zamiast tego utwórz Plugin kanału, jeśli integrujesz zewnętrzną sieć komunikacyjną mającą własnych użytkowników, pokoje, dostarczanie przez Webhook lub transport wychodzący. Zobacz Tworzenie pluginów.

​

Kontrakt modelu zorientowany na agenta

​

Zachowanie sesji

​

Limity żądań (konfiguracja)

{
  gateway: {
    http: {
      endpoints: {
        chatCompletions: {
          enabled: true,
          maxBodyBytes: 20000000,
          maxImageParts: 8,
          maxTotalImageBytes: 20000000,
          images: {
            allowUrl: false,
            urlAllowlist: ["cdn.example.com", "*.assets.example.com"],
            allowedMimes: [
              "image/jpeg",
              "image/png",
              "image/gif",
              "image/webp",
              "image/heic",
              "image/heif",
            ],
            maxBytes: 10485760,
            maxRedirects: 3,
            timeoutMs: 10000,
          },
        },
      },
    },
  },
}

​

Kontrakt narzędzi czatu

​

Obsługiwane pola żądania

• Limit tokenów: nazwę pola przesyłanego protokołem wybiera warstwa transportowa dostawcy: max_completion_tokens dla punktów końcowych z rodziny OpenAI, a max_tokens dla dostawców akceptujących wyłącznie starszą nazwę (Mistral, Chutes).
• stop jest mapowane na pole zatrzymania warstwy transportowej: stop dla backendów Chat Completions, stop_sequences dla Anthropic. Interfejs OpenAI Responses API nie ma parametru zatrzymania, więc stop nie jest stosowane w modelach opartych na Responses.
• Backend Codex Responses oparty na ChatGPT używa stałego próbkowania po stronie serwera i usuwa temperature/top_p (wraz z max_output_tokens, metadata, prompt_cache_retention, service_tier), zanim żądanie dotrze do tego backendu.

​

Nieobsługiwane warianty

• tools, które nie jest tablicą, elementów narzędzi niebędących funkcjami lub braku tool.function.name
• wariantów tool_choice, takich jak allowed_tools i custom
• wartości tool_choice.function.name, które nie odpowiadają żadnemu dostarczonemu narzędziu

​

Format odpowiedzi narzędzia bez strumieniowania

• choices[0].finish_reason = "tool_calls"
• elementy choices[0].message.tool_calls[] z polami id, type: "function", function.name, function.arguments (ciąg JSON)
• Komentarz asystenta przed wywołaniem narzędzia w choices[0].message.content (może być pusty)

​

Format strumieniowej odpowiedzi narzędzia

​

Pętla kontynuacji po wywołaniu narzędzia

​

Strumieniowanie (SSE)

• Content-Type: text/event-stream
• Każdy wiersz zdarzenia ma postać data: <json>
• Strumień kończy się wpisem data: [DONE]

​

Szybka konfiguracja Open WebUI

• Bazowy adres URL: http://127.0.0.1:18789/v1
• Bazowy adres URL Dockera w systemie macOS: http://host.docker.internal:18789/v1
• Klucz API: token okaziciela Gateway
• Model: openclaw/default

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

​

Przykłady

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",
    "user": "conv:YOUR_CONVERSATION_ID",
    "messages": [{"role":"user","content":"Summarize my tasks for today"}]
  }'

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

​

Powiązane

• Dokumentacja konfiguracji
• Zakresy operatora
• OpenAI