Tổng quan API

API làm được gì

Mọi việc bạn làm trên giao diện web đều có thể gọi bằng mã: dựng video từ kịch bản, đăng lên các kênh đã nối, dựng nguồn tin quét tự động, chạy chiến dịch theo lịch, tải tệp lên kho media, và đọc số liệu hiệu quả.

API dùng chung dữ liệu với tài khoản web. Video tạo bằng API hiện ngay trong Kho video, và ngược lại.

Địa chỉ gốc

…/api/v1/public

Đường này tách hẳn khỏi các endpoint mà giao diện web dùng. Nhờ vậy hợp đồng của bạn không đổi theo mỗi lần chỉnh giao diện: trường nào có mặt ở đây là trường đã được cân nhắc để đưa ra ngoài.

Mọi đường dẫn trong tài liệu này viết tương đối so với địa chỉ gốc ở trên: GET /videos nghĩa là GET …/api/v1/public/videos.

Bắt đầu trong ba bước

1. 1

   Tạo khoá API

   Vào Cài đặt → Khoá API, đặt tên và tích các quyền cần dùng. Chuỗi khoá đầy đủ chỉ hiện đúng một lần.

2. 2

   Gọi thử một endpoint chỉ đọc

   curl …/api/v1/public/credits \
     -H "X-Api-Key: viai_sk_..."

3. 3

   Tạo video đầu tiên

   Lấy id kênh từ GET /channels, rồi gọi POST /videos kèm header chống trùng. Xem Video và việc sinh nội dung.

Bản đồ endpoint

Tính tiền thế nào

• API không phải gói trả phí riêng. Tài khoản nào có credit là gọi được.
• Giá mỗi việc giống hệt khi làm trên web — xem Cách tính credit. Gọi qua API không rẻ hơn và cũng không đắt hơn.
• Những endpoint chỉ đọc không tốn credit. Endpoint tạo video, xếp việc sinh nội dung và chạy chiến dịch thì có.
• Hạn mức kênh và dung lượng lưu trữ vẫn áp dụng như trên web: hết suất kênh thì lượt tạo video trỏ vào kênh mới sẽ bị từ chối.

Những gì API không mở