AGTCloud API Docs
Hướng dẫnAPI ReferenceTích hợp và tài nguyênCập nhật và hỗ trợ

API Reference

Tìm AGTCloud API theo tác vụ phát triển và xem endpoint, tham số, phản hồi cùng công cụ thử API trực tuyến.

AGTCloud API Reference cung cấp địa chỉ yêu cầu, phương thức xác thực, Schema tham số, cấu trúc phản hồi, ví dụ mã và công cụ thử API trực tuyến cho từng API. Bạn có thể tìm API theo tác vụ trước, rồi mở trang endpoint cụ thể để xem đầy đủ các trường.

Gọi API lần đầu

Nếu chưa có API Key hoặc chưa xác định Base URL và ID mô hình, hãy đọc Bắt đầu nhanh trước. Nếu đã hoàn thành cấu hình cơ bản, bạn có thể chọn API cần dùng bên dưới.

Khả năng chính

Văn bản, hình ảnh và video là các mục chính hiện tại của API Reference. Một khả năng có thể cung cấp đồng thời định dạng tương thích OpenAI, định dạng của nhà cung cấp hoặc định dạng tác vụ bất đồng bộ AGTCloud. Hãy chọn theo SDK hiện có và mô hình mục tiêu.

API khác

Chọn theo hình thức API

Các khả năng sử dụng hình thức truyền và cách lấy kết quả khác nhau. Phía máy khách cần xử lý dữ liệu theo Content-Type và loại phản hồi trên trang endpoint.

Hình thức APITình huống phổ biếnCách xử lý phía máy khách
JSON đồng bộVăn bản thông thường, Embedding, RerankPhân tích phản hồi JSON sau khi yêu cầu hoàn tất
Phản hồi SSE dạng luồngChat, Responses, Gemini dạng luồngĐọc sự kiện liên tục đến khi luồng kết thúc
Tác vụ bất đồng bộVideo, MidjourneyLưu ID tác vụ và truy vấn trạng thái cùng kết quả
Tải lên MultipartChỉnh sửa hình ảnh, phiên âm âm thanhTải tệp và trường biểu mẫu theo yêu cầu của endpoint
Phản hồi nhị phânTải nội dung video hoặc âm thanhLưu tệp theo kiểu phương tiện của phản hồi
WebSocketRealtimeThiết lập kết nối dài hạn và liên tục gửi, nhận sự kiện

Cách đọc trang endpoint

Xác nhận Endpoint và xác thực

Kiểm tra Method, Path, địa chỉ API và Header xác thực mà endpoint yêu cầu. Xem quy tắc chung trong Quy ước chung.

Chọn tình huống yêu cầu

Chọn ví dụ gần với tác vụ hiện tại nhất, rồi điều chỉnh các trường theo Request Body, Path Parameters hoặc Query Parameters.

Kiểm tra phản hồi và lỗi

Phân tích kết quả theo trạng thái HTTP và kiểu phương tiện phản hồi. Khi thất bại, lưu thông tin lỗi đã che dữ liệu nhạy cảm và Request ID nếu có trong phản hồi, rồi xem Lỗi và khắc phục sự cố.

Kiểm tra bằng Try It

Công cụ thử API trực tuyến dùng địa chỉ API hiển thị trên trang này. Nhập API Key của tài khoản hiện tại và chọn mô hình khả dụng từ danh sách mô hình. Không dùng Key dài hạn của môi trường production trên thiết bị dùng chung.

Quy tắc chung trước khi tích hợp

  • Nếu chưa biết nên dùng giao thức văn bản nào, hãy đọc Chọn giao thức trước.
  • Thay MODEL_ID trong ví dụ Reference bằng ID mô hình thực sự khả dụng với API Key hiện tại.
  • Các khả năng cùng tên có thể hỗ trợ trường khác nhau tùy mô hình và giao thức; căn cứ vào endpoint hiện tại, quyền tài khoản và phản hồi thực tế.
  • Ứng dụng production không được mã hóa cứng API Key trong trình duyệt hoặc gói ứng dụng phía máy khách. Try It chỉ dùng để thử tạm thời; không ghi Key vào kho mã công khai, ảnh chụp màn hình hoặc log.

Đọc tiếp: Quy ước chung · API Key, Base URL và xác thực

Trên trang này