REST API
POST /api/process nhận link hoặc file. GET /api/status/{job_id} trả tiến độ và danh sách clip.
Xem APIGửi một link video qua REST API hoặc MCP, nhận clip dọc qua webhook, rồi nối tiếp bằng n8n. Mọi lệnh gọi dùng tài khoản và credit của bạn.
Cả bốn đều chạy qua các route của backend, nên quyền, credit và quyền sở hữu job giống hệt dashboard.
POST /api/process nhận link hoặc file. GET /api/status/{job_id} trả tiến độ và danh sách clip.
Xem APIPOST /mcp cho agent 8 tool: tạo job, tải file lên, đọc trạng thái, liệt kê clip, phụ đề, cắt lại, đăng bài.
Xem MCPTruyền webhook_url để nhận một POST khi job kết thúc. Thêm webhook_secret để body được ký HMAC-SHA256.
Xem webhookHai workflow mẫu đi kèm mã nguồn trong examples/n8n: một bản gửi link rồi nhận clip, một bản chạy theo kênh YouTube.
Xem n8nBa bước, chạy được với curl và jq. BASE là địa chỉ backend của VimeoClip.
BASE=http://localhost:8000
# 1. Đăng nhập. Response có access_token.
TOKEN=$(curl -s -X POST "$BASE/api/auth/login" \
-H "Content-Type: application/json" \
-d '{"email":"you@example.com","password":"YOUR_PASSWORD"}' | jq -r .access_token)
# 2. Tạo job. Response có job_id.
JOB_ID=$(curl -s -X POST "$BASE/api/process" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"url":"https://www.youtube.com/watch?v=VIDEO_ID","acknowledged":true}' | jq -r .job_id)
# 3. Đọc trạng thái và danh sách clip.
curl -s "$BASE/api/status/$JOB_ID" -H "Authorization: Bearer $TOKEN" \
| jq '{status, progress, clips: .result.clips}'Tài khoản mới có quyền member. Route chưa nằm trong danh sách cho member thì chỉ admin gọi được.
| Việc cần làm | Route | Quyền tối thiểu |
|---|---|---|
| Tạo job, tải file lên | POST /api/process, POST /api/uploads | Member |
| Đọc trạng thái, tải clip của mình | GET /api/status/{job_id}, GET /videos/{job_id}/… | Member, chủ job |
| Dùng agent | POST /mcp | Member |
| Sửa phụ đề, cắt lại clip | POST /api/subtitle, POST /api/clip/rerender | Admin |
| Đăng hoặc lên lịch bài | POST /api/social/post | Admin |
Chưa đăng nhập thì nhận 401. Member gọi route chỉ dành cho admin thì nhận 403.
Có. POST /api/process giữ credit của tài khoản khi job được nhận, kể cả tài khoản admin. MCP gọi lại đúng route đó nên trừ theo cùng cách. Job lỗi hoặc bị huỷ được hoàn lại.
YouTube, TikTok và Instagram, qua Upload-Post. Việc đăng cần quyền admin và key Upload-Post.
Với script ngắn, gọi GET /api/status/{job_id} mỗi 30 đến 60 giây là đủ. Với pipeline tự động, truyền webhook_url để nhận kết quả một lần khi job kết thúc.
Trang API có đủ field của POST /api/process, cách đọc clip và các mã lỗi.
Video minh hoạ (stock), không phải kết quả của VimeoClip · Storyblocks