Bỏ qua, tới nội dung chính

Tài liệu

Tài liệu Chat Tự Động

Toàn bộ tài liệu cần thiết để tích hợp Chat Tự Động vào sản phẩm của bạn, từ một dòng mã nhúng widget cho tới việc gọi trực tiếp model qua endpoint tương thích OpenAI.

Ba hình thức triển khai

Trước khi tra cứu chi tiết, bạn nên xác định hình thức triển khai phù hợp với nhu cầu của mình:

Triển khai trợ lý mà không cần lập trình
Truy cập bảng điều khiển để tạo trợ lý, nạp tài liệu và kết nối kênh. Tham khảo Hướng dẫn nhanh, phần đầu không yêu cầu thao tác với mã nguồn.
Gọi model từ hệ thống backend của doanh nghiệp
Khởi tạo API key rồi trỏ SDK OpenAI sẵn có sang https://api.chattudong.com/v1. Tham khảo SDK và thư viện cùng API Reference.
Nhúng khung chat vào website
Tạo kênh loại web_widget, khai báo danh sách tên miền được phép nhúng rồi chèn một thẻ <script>. Chi tiết ở cuối trang Hướng dẫn nhanh.

Mục lục

Kiểm thử nhanh bằng một lệnh

Để xác minh nhanh, hãy khởi tạo API key trong mục Cài đặt → Khoá API của bảng điều khiển rồi chạy lệnh dưới đây. Endpoint tuân theo đúng định dạng OpenAI nên mọi thư viện sẵn có đều tương thích.

Terminal
curl https://api.chattudong.com/v1/chat/completions \
  -H "Authorization: Bearer $CHATLY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "model": "local/gemma-3-12b",
    "messages": [{"role": "user", "content": "Chào bạn"}]
  }'

Danh sách model khả dụng được truy vấn qua GET /v1/models. Không nên phỏng đoán tên model vì mỗi tổ chức có thể được kích hoạt những model khác nhau.

Các nguyên tắc áp dụng xuyên suốt

  • Cấu trúc lỗi thống nhất. Với mọi endpoint, thân phản hồi lỗi luôn có dạng { error: { code, message, requestId } }. Mã lỗi được duy trì ổn định và việc đổi tên mã được coi là breaking change, nên bạn có thể xử lý theo mã một cách an toàn.
  • Thông tin bí mật chỉ hiển thị một lần. API key và khoá BYOK không thể xem lại sau khi khởi tạo. Trường hợp thất lạc, doanh nghiệp cần tạo khoá mới. Cơ chế này bảo đảm khoá không thể khôi phục kể cả khi cơ sở dữ liệu bị truy cập trái phép.
  • Chữ ký webhook tính trên body thô. Đây là điểm dễ sai sót nhất khi tự triển khai, được trình bày chi tiết tại trang webhooks.
  • Trả trước, dừng khi hết số dư. Khi hết credits, API trả về 402 insufficient_credits thay vì ghi nhận công nợ.

Hỗ trợ kỹ thuật

Nếu tài liệu còn thiếu nội dung hoặc bạn gặp lỗi chưa xác định được nguyên nhân, vui lòng cung cấp giá trị error.requestId trong phản hồi lỗi. Mã này cho phép chúng tôi truy xuất chính xác nhật ký của request tương ứng.

Email hỗ trợ: chattudongcskh@gmail.com. Các vấn đề liên quan tới bảo mật vui lòng gửi riêng về chattudongcskh@gmail.com.