AutoClip

REST API · v1

Jobs & projects

Submit a video, follow processing, and retrieve finished clips.

https://polished-turtle-977.convex.siteGet an API key
POST

/api/v1/jobs

Submit a video for clipping.

Input
{ url, maxClips?, reframeMode?, outputAspect?, clipLengthPreference?, processStartSec?, processEndSec? }
Response shape
201 { id, status }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/jobs' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json

Save the input fields as request.json before running a write request. Replace path placeholders with your own IDs.

GET

/api/v1/jobs

List recent jobs, newest first.

Input
?limit= (1–25, default 10)
Response shape
{ jobs[] }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/jobs' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
GET

/api/v1/jobs/{id}

Read job status, progress, clip count, and any failure.

Response shape
{ id, status, progressPct, clipCount, error? }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/jobs/{id}' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
GET

/api/v1/jobs/{id}/clips

Get finished clips and signed download links.

Response shape
{ jobId, clips[] }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/jobs/{id}/clips' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
POST

/api/v1/projects

Create a clipping project using the jobs submission contract.

Input
Same as POST /api/v1/jobs
Response shape
201 { id, status }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/projects' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json

Save the input fields as request.json before running a write request. Replace path placeholders with your own IDs.

GET

/api/v1/projects/{id}

Read project processing status.

Response shape
{ id, status, progressPct, videoTitle, clipCount, error? }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/projects/{id}' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
GET

/api/v1/projects/{id}/clips

Get a project's ranked clips.

Response shape
{ projectId, clips[] }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/projects/{id}/clips' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
DELETE

/api/v1/projects/{id}

Permanently delete a project and its clips.

Response shape
{ ok, deletedClips }
curl --request DELETE 'https://polished-turtle-977.convex.site/api/v1/projects/{id}' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"