Tài liệu tham khảo API

Tài liệu tham khảo này cung cấp cho các nhà phát triển và tác nhân tự động hóa một nơi tra cứu cô đọng về các endpoint Weydub API, kiểm tra quyền truy cập, cấu trúc yêu cầu, hành vi không đồng bộ, quy tắc thanh toán/lưu giữ và các dấu hiệu phục vụ việc khắc phục sự cố.

Thông tin cơ bản về yêu cầu

Một số tên cơ sở hạ tầng cũ vẫn có thể xuất hiện trong các tài nguyên demo công khai hoặc đường dẫn tài khoản cũ. Hãy coi tài liệu Weydub API này là quy ước hiện hành dành cho sản phẩm.

Trước khi thực hiện lệnh gọi

Xác thực

Hầu hết các yêu cầu sử dụng các header:

Content-Type: application/json
AppKey: $WEYDUB_APP_KEY
AppSign: md5(md5(request_body) + $WEYDUB_APP_SECRET)

Hãy ký chính xác phần thân JSON dạng thu gọn sẽ được gửi. Đọc Xác thực và ký trước khi gỡ lỗi các trường hợp chữ ký không hợp lệ.

Ngoại lệ không cần ký:

POST /v-w-c/enum/query2

Endpoint truy vấn enum được dùng cho các danh sách ngôn ngữ/trạng thái động và không yêu cầu ký.

Danh mục endpoint

Tạo tác vụ video

POST /v-w-c/gateway/ve/work/free

Các quy trình phổ biến sử dụng endpoint này:

Yêu cầu tối thiểu:

{
  "urls": ["https://example.com/demo.mp4"],
  "needChineseOcclude": 1,
  "videoInpaintLang": "all",
  "callback": "https://your-domain.example/webhooks/weydub"
}

Các trường thường gặp trong phản hồi tạo tác vụ:

Truy vấn trạng thái video

POST /v-w-c/gateway/ve/work/status

{
  "idWorks": [488026661]
}

Các giá trị trạng thái:

Các tác vụ video thành công có thể bao gồm videoUrl, coverUrl, srcSrtUrl, tgtSrtUrl, sourceVideoUrl, ttsMetaResult, wyVoiceParam và siêu dữ liệu tác vụ.

Tác vụ hình ảnh

Endpoint tạo công khai hiện tại:

POST /v-w-c/gateway/ve/image/translate

Endpoint thực hiện lại:

POST /v-w-c/gateway/ve/image/translate/redo

Yêu cầu dịch hình ảnh:

{
  "srcLang": "en",
  "tgtLang": "es",
  "translateOn": 1,
  "synthesisOn": 1,
  "commodityFilterOn": 0,
  "downloadInfo": "{\"url\":\"https://example.com/product.png\",\"fileName\":\"product.png\",\"id\":12345,\"materialName\":\"product.png\"}",
  "app": "WD"
}

Yêu cầu xóa văn bản khỏi hình ảnh:

{
  "srcLang": "en",
  "tgtLang": "en",
  "translateOn": 0,
  "synthesisOn": 1,
  "commodityFilterOn": 0,
  "downloadInfo": "{\"url\":\"https://example.com/banner.png\",\"fileName\":\"banner.png\",\"id\":12346,\"materialName\":\"banner.png\"}",
  "app": "WD"
}

Đọc Dịch hình ảnh trước khi triển khai tác vụ hình ảnh vì downloadInfo, downloadInfos và result khi thực hiện lại phải giữ nguyên định dạng chuỗi được nêu trong tài liệu.

Truy vấn enum

POST /v-w-c/enum/query2

Endpoint này không yêu cầu AppSign.

{
  "text": "Lang"
}

Các tên enum phổ biến:

Thanh toán, giới hạn và lưu giữ

Tóm tắt về callback

Truyền callback URL trong các yêu cầu tạo khi được hỗ trợ. Weydub gửi trực tiếp mục công việc đã hoàn tất đến máy chủ của bạn mà không có lớp bao bọc bên ngoài code / msg / body được dùng trong các phản hồi thăm dò.

Quy tắc xử lý callback:

• Xác minh Callback-Sign bằng phần thân thô của yêu cầu callback và AppSecret của bạn.
• Chỉ trả về HTTP 200 cùng phần thân không rỗng sau khi lưu trữ bền vững thành công.
• Thiết kế các trình xử lý có tính lũy đẳng theo ID công việc/tác vụ.
• Các callback thất bại đối với tác vụ được tạo trong vòng 24 giờ qua được thử lại khoảng 30 phút một lần.
• Nếu thao tác làm lại thay đổi nội dung video hoặc hình ảnh, URL đầu ra có thể thay đổi; hãy lưu lại URL mới nhất.

Đọc Mô hình tác vụ bất đồng bộ để biết chi tiết về callback.

Khắc phục sự cố

Quy ước dành cho tác nhân

Các tác nhân tự động hóa nên:

• Tải llms.txt và Kỹ năng Weydub API.
• Sử dụng Các kịch bản demo trước khi sử dụng nội dung đa phương tiện của khách hàng.
• Lưu thông tin xác thực trong các biến môi trường hoặc trình quản lý bí mật.
• Lưu trữ bền vững các ID trước khi báo cáo thành công cho người dùng.
• Mô hình hóa các tác vụ theo submitted -> processing -> succeeded | failed | timed_out.
• Không bao giờ để lộ AppSecret hoặc tự đặt ra các endpoint đã được bật.