API

Gateway (cổng 8080, cần API key trừ /health và /readyz; /readyz liệt kê các lớp phát hiện đang chạy): POST /v1/chat/completions, POST /v1/completions, POST /guardrail/scan (chấm text và documents không gọi model), POST /guardrail/scan/tools (chấm định nghĩa tool MCP), POST /guardrail/sanitize.

Control plane (cổng 8081, compose mở ra 18081): đăng nhập, tổ chức, API key, project, policy, guard settings, exemplar, lời mời, audit log. Bảng đầy đủ và ví dụ curl ở mục APIs.

GET /v1/organizations/:orgId/dashboard?window=24h|7d|30d&project_id= (vai trò viewer trở lên, như /requests) trả về số liệu tổng hợp của nhật ký yêu cầu, tính trong Postgres trên toàn bộ khoảng thời gian: tổng số yêu cầu, số bị chặn, tỷ lệ chặn, số theo quyết định, độ trễ p50/p95/p99, chuỗi thời gian theo giờ (24h) hoặc theo ngày (UTC), các nhãn phát hiện, luật và dự án nhiều nhất. Trang Bảng điều khiển dùng endpoint này.

Giao diện quản trị#

Control plane phục vụ giao diện quản trị tại /ui/ (với compose: http://localhost:18081/ui/), bằng tiếng Việt hoặc tiếng Anh, giao diện sáng hoặc tối. Đăng nhập bằng tài khoản control plane rồi mở tổ chức theo id (tổ chức tạo khi cài đặt là 00000000-0000-0000-0000-000000000001).

Trang Luồng xử lý vẽ đường đi của một request qua gateway: khóa API, lớp L0, các lớp phát hiện L1, L2, L3, các luật theo đúng thứ tự của gateway, các kết quả Chặn, Ghi log, Cho phép và các upstream. Sửa điều kiện của luật bằng bộ dựng trực quan hoặc dạng văn bản, kéo để đổi thứ tự, kéo từ điểm "khớp" của luật đến một upstream để định tuyến, và thử request bằng bộ mô phỏng. Ngoài ra có các trang Upstream, Cấu hình dạng mã (YAML: kiểm tra, xem khác biệt, áp dụng), Thiết lập bảo vệ, Khóa API, Dự án, Mẫu tham chiếu và Nhật ký kiểm tra. Chi tiết ở mục Admin UI.

Nguồn: README.vi.md#api @ ca69dad29f02