OpenAI-Chat-Vervollständigungen

​

Endpunkt aktivieren

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

​

Sicherheitsgrenze (wichtig)

• Ein gültiges Gateway-Token/-Passwort für diesen Endpunkt entspricht einer Zugangsinformation für Eigentümer/Operatoren und nicht einem eingeschränkten benutzerspezifischen Geltungsbereich.
• Anfragen durchlaufen denselben Agentenpfad der Steuerungsebene wie vertrauenswürdige Operatoraktionen. Wenn die Richtlinie des Zielagenten sensible Werkzeuge zulässt, kann dieser Endpunkt sie daher verwenden.
• Beschränken Sie ihn auf Loopback, Tailnet oder privaten Eingang. Stellen Sie ihn nicht im öffentlichen Internet bereit.

​

Authentifizierung

• Aufrufer auf demselben Host, die den Proxy eines trusted-proxy-Gateways umgehen, können direkt auf gateway.auth.password / OPENCLAW_GATEWAY_PASSWORD zurückgreifen. Nachweise durch einen Forwarded-, X-Forwarded-*- oder X-Real-IP-Header belassen die Anfrage stattdessen auf dem Trusted-Proxy-Pfad.
• Wenn gateway.auth.rateLimit konfiguriert ist und zu viele Authentifizierungsversuche fehlschlagen, gibt der Endpunkt 429 mit einem Retry-After-Header zurück.

​

Wann dieser Endpunkt verwendet werden sollte

• Bevorzugen Sie diesen Endpunkt gegenüber dem Hinzufügen eines neuen integrierten Kanals, wenn Ihre Integration lediglich eine weitere Operator-/Client-Oberfläche für denselben Gateway ist.
• Für native mobile Clients, die sich direkt mit einem entfernten Gateway verbinden, sollten Sie WebChat oder das Gateway-Protokoll mit dem Bootstrap-/Geräte-Token-Ablauf für gekoppelte Geräte bevorzugen, damit das Gerät kein gemeinsames HTTP-Token/-Passwort benötigt.
• Erstellen Sie stattdessen ein Kanal-Plugin, wenn Sie ein externes Messaging-Netzwerk mit eigenen Benutzern, Räumen, Webhook-Zustellung oder ausgehendem Transport integrieren. Siehe Plugins erstellen.

​

Agentenorientierter Modellvertrag

​

Sitzungsverhalten

​

Anfragebeschränkungen

{
  gateway: {
    http: {
      endpoints: {
        chatCompletions: {
          enabled: true,
          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,
          },
        },
      },
    },
  },
}

​

Vertrag für Chat-Werkzeuge

​

Unterstützte Anfragefelder

• Tokenbegrenzung: Der Feldname im Übertragungsformat wird vom Provider-Transport gewählt: max_completion_tokens für Endpunkte der OpenAI-Familie, max_tokens für Provider, die nur den veralteten Namen akzeptieren (Mistral, Chutes).
• stop wird dem Stop-Feld des Transports zugeordnet: stop für Chat-Completions-Backends, stop_sequences für Anthropic. Die OpenAI Responses API besitzt keinen Stop-Parameter, daher wird stop bei Responses-basierten Modellen nicht angewendet.
• Das ChatGPT-basierte Codex-Responses-Backend verwendet serverseitig festgelegtes Sampling und entfernt temperature/top_p (zusammen mit max_output_tokens, metadata, prompt_cache_retention, service_tier), bevor die Anfrage dieses Backend erreicht.

​

Nicht unterstützte Varianten

• tools, die keine Arrays sind, Werkzeugeinträge, die keine Funktionen sind, oder fehlendes tool.function.name
• tool_choice-Varianten wie allowed_tools und custom
• tool_choice.function.name-Werte, die keinem bereitgestellten Werkzeug entsprechen

​

Struktur der nicht gestreamten Werkzeugantwort

• choices[0].finish_reason = "tool_calls"
• choices[0].message.tool_calls[]-Einträge mit id, type: "function", function.name, function.arguments (JSON-Zeichenfolge)
• Assistentenkommentar vor dem Werkzeugaufruf in choices[0].message.content (möglicherweise leer)

​

Struktur der gestreamten Werkzeugantwort

​

Nachfolgeschleife für Werkzeuge

​

Streaming (SSE)

• Content-Type: text/event-stream
• Jede Ereigniszeile ist data: <json>
• Der Stream endet mit data: [DONE]

​

Open WebUI-Schnelleinrichtung

• Basis-URL: http://127.0.0.1:18789/v1
• Basis-URL für Docker unter macOS: http://host.docker.internal:18789/v1
• API-Schlüssel: Ihr Gateway-Bearer-Token
• Modell: openclaw/default

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

​

Beispiele

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":"Fasse meine Aufgaben für heute zusammen"}]
  }'

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

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

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

​

Verwandte Themen

• Konfigurationsreferenz
• Operator-Berechtigungsbereiche
• OpenAI