mirror of
https://gitee.com/mateos/mateclaw.git
synced 2026-09-13 11:13:43 +08:00
docs/zh/webchat.md — single source of truth for downstream integrators. Covers everything needed to embed MateClaw webchat into a third-party site without reading source: - Base URL, auth model (API Key + visitorToken), R<T> response wrap - Endpoint table (14 visitor-facing + 2 admin) - Auth flow diagram (how visitorToken gets minted on /stream, reused on management endpoints) - Error code table (400/401/404/409 with semantics) - SSE event protocol (meta / content_delta / thinking_delta / done / error) - File upload + download flow (visitor-attached vs agent-generated; /api/v1/files/generated/<uuid> is permitAll + 7d TTL) - visitorToken revocation admin endpoint - Three end-to-end curl examples (first message / list sessions / upload-then-send) - Limits (5 empty-session quota, upload caps, 7d expirations, single-instance constraint today) @Operation / @Parameter / @ApiResponse / @ExampleObject polish on WebChatController is intentionally deferred — it's noisy mechanical work that deserves its own focused PR rather than getting rushed in here. The doc is the canonical reference now; the swagger annotations can quote it. Part of epic #355. |
||
|---|---|---|
| .. | ||
| java/vip/mate | ||
| resources | ||