From 56b11ad5a8ccfb347378495e414b1dee76d0bcd9 Mon Sep 17 00:00:00 2001 From: Peter Steinberger Date: Sat, 10 Jan 2026 22:35:38 +0100 Subject: [PATCH] docs(gateway): rename OpenAI HTTP endpoint doc --- docs/gateway/index.md | 2 +- docs/gateway/openai-http-api.md | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/gateway/index.md b/docs/gateway/index.md index a9f0a70b9..b337135da 100644 --- a/docs/gateway/index.md +++ b/docs/gateway/index.md @@ -28,7 +28,7 @@ pnpm gateway:watch - Disable with `gateway.reload.mode="off"`. - Binds WebSocket control plane to `127.0.0.1:` (default 18789). - The same port also serves HTTP (control UI, hooks, A2UI). Single-port multiplex. - - OpenAI-compatible HTTP API: [`/v1/chat/completions`](/gateway/openai-http-api). + - OpenAI Chat Completions (HTTP): [`/v1/chat/completions`](/gateway/openai-http-api). - Starts a Canvas file server by default on `canvasHost.port` (default `18793`), serving `http://:18793/__clawdbot__/canvas/` from `~/clawd/canvas`. Disable with `canvasHost.enabled=false` or `CLAWDBOT_SKIP_CANVAS_HOST=1`. - Logs to stdout; use launchd/systemd to keep it alive and rotate logs. - Pass `--verbose` to mirror debug logging (handshakes, req/res, events) from the log file into stdio when troubleshooting. diff --git a/docs/gateway/openai-http-api.md b/docs/gateway/openai-http-api.md index 831c5f301..d6b2e0021 100644 --- a/docs/gateway/openai-http-api.md +++ b/docs/gateway/openai-http-api.md @@ -3,9 +3,9 @@ summary: "Expose an OpenAI-compatible /v1/chat/completions HTTP endpoint from th read_when: - Integrating tools that expect OpenAI Chat Completions --- -# OpenAI-compatible HTTP API +# OpenAI Chat Completions (HTTP) -Clawdbot’s Gateway can serve a small OpenAI-compatible endpoint: +Clawdbot’s Gateway can serve a small OpenAI-compatible Chat Completions endpoint: - `POST /v1/chat/completions` - Same port as the Gateway (WS + HTTP multiplex): `http://:/v1/chat/completions`