AutoClip

REST API · v1

Uploads, sources & clip management

Additions to the jobs and clips routes documented further down. POST /api/v1/jobs also accepts videoKey (from an upload, instead of a URL) plus captionMode, captionStyle, userPrompt, clipMode, autoPostOnComplete, sfx, upscale, broll, removeFillerWords, removePauses and spokenHook options.

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

/api/v1/uploads

Get a presigned upload URL for a local file.

Input
{ filename, contentType, sizeBytes }
Response shape
{ uploadUrl, videoKey, expiresAt }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/uploads' \
  --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.

POST

/api/v1/jobs/batch

Submit up to 10 jobs at once.

Input
{ jobs: SubmitJobBody[] }
Response shape
results per job
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/jobs/batch' \
  --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/sources/probe

Check a source URL and estimate its credit cost before submitting.

Input
?url=
Response shape
{ platform, durationSec, title, estimatedCredits, supported }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/sources/probe' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
PATCH

/api/v1/projects/{id}

Rename or save a project.

Input
{ name?, saved? }
Response shape
Project
curl --request PATCH 'https://polished-turtle-977.convex.site/api/v1/projects/{id}' \
  --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.

POST

/api/v1/projects/{id}/duplicate

Duplicate a project. Also /dismiss and /more-clips (find more clips in the same source).

Response shape
Project
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/projects/{id}/duplicate' \
  --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/clips

Your clips.

Input
?status= &campaignId= &jobId=
Response shape
{ data: Clip[], nextCursor }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/clips' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
GET

/api/v1/clips/{id}

One clip.

Response shape
Clip
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/clips/{id}' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
PATCH

/api/v1/clips/{id}

Set a clip's title.

Input
{ title }
Response shape
Clip
curl --request PATCH 'https://polished-turtle-977.convex.site/api/v1/clips/{id}' \
  --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.

POST

/api/v1/clips/{id}/approve

Approve a clip. Also /discard and /regenerate-title.

Response shape
Clip
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/clips/{id}/approve' \
  --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.

PATCH

/api/v1/social-accounts/{id}

Label a connected account. GET /social-accounts also returns needsReconnect and reconnectActionLink.

Input
{ label }
Response shape
SocialAccount
curl --request PATCH 'https://polished-turtle-977.convex.site/api/v1/social-accounts/{id}' \
  --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.

DELETE

/api/v1/social-accounts/{id}

Disconnect a social account.

Input
{ confirm: true }
Response shape
204

This endpoint requires confirmation. Review the action before sending confirm: true.

curl --request DELETE 'https://polished-turtle-977.convex.site/api/v1/social-accounts/{id}' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY" \
  --header "Content-Type: application/json" \
  --data @request.json
POST

/api/v1/brand-templates

Create a brand template. Also PATCH and DELETE (confirm) /brand-templates/{id}.

Response shape
BrandTemplate
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/brand-templates' \
  --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.

POST

/api/v1/webhooks/{id}/test

Send a ping event to an endpoint.

Response shape
{ delivered, status }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/webhooks/{id}/test' \
  --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.