REST API
POST /api/process takes a link or a file. GET /api/status/{job_id} returns progress and the clip list.
See the APISend a video link through the REST API or MCP, get vertical clips back on a webhook, and carry on in n8n. Every call runs under your own account and credits.
All four run through the backend routes, so permissions, credits and job ownership match the dashboard exactly.
POST /api/process takes a link or a file. GET /api/status/{job_id} returns progress and the clip list.
See the APIPOST /mcp gives an agent 8 tools: start a job, upload a file, read status, list clips, restyle captions, recut, publish.
See MCPPass webhook_url to get one POST when the job ends. Add webhook_secret and the body is signed with HMAC-SHA256.
See webhooksTwo workflow templates ship with the source in examples/n8n: one takes a link and returns clips, one follows a YouTube channel.
See n8nThree steps with curl and jq. BASE is the VimeoClip backend address.
BASE=http://localhost:8000
# 1. Sign in. The response carries 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. Start a job. The response carries 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. Read the status and the clips.
curl -s "$BASE/api/status/$JOB_ID" -H "Authorization: Bearer $TOKEN" \
| jq '{status, progress, clips: .result.clips}'A new account is a member. A route that is not on the member list can only be called by an admin.
| What you want to do | Route | Minimum role |
|---|---|---|
| Start a job, upload a file | POST /api/process, POST /api/uploads | Member |
| Read status, download your clips | GET /api/status/{job_id}, GET /videos/{job_id}/… | Member, job owner |
| Use an agent | POST /mcp | Member |
| Restyle captions, recut a clip | POST /api/subtitle, POST /api/clip/rerender | Admin |
| Publish or schedule a post | POST /api/social/post | Admin |
Without a session you get 401. A member calling an admin route gets 403.
Yes. POST /api/process reserves the account's credits when the job is accepted, admin accounts included. MCP calls that same route, so it is charged the same way. A failed or cancelled job is refunded.
YouTube, TikTok and Instagram, through Upload-Post. Publishing needs an admin role and an Upload-Post key.
For a short script, calling GET /api/status/{job_id} every 30 to 60 seconds is enough. For an automated pipeline, pass webhook_url and get the result once when the job ends.
The API page lists the POST /api/process fields, how to read clips and the error codes.
Illustration (stock video), not VimeoClip output · Storyblocks