REST API · v1
Clip processing
Read transcripts, update a clip, and generate supporting assets.
https://polished-turtle-977.convex.siteGet an API key/api/v1/clips/{id}/duplicate
Duplicate a finished clip.
- Response shape
- { clipId, sourceClipId }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/clips/{id}/duplicate' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY" \
--header "Content-Type: application/json" \
--data @request.jsonSave the input fields as request.json before running a write request. Replace path placeholders with your own IDs.
/api/v1/clips/{id}/edit
Re-render a finished clip with an edit.
- Input
- { op: "trim" | "extend" | "fix_captions" | "set_caption_text", startSec?, endSec?, segmentIndex?, wordIndex?, text? }
- Response shape
- { clipId, status: "reframing" }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/clips/{id}/edit' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY" \
--header "Content-Type: application/json" \
--data @request.jsonSave the input fields as request.json before running a write request. Replace path placeholders with your own IDs.
/api/v1/transcripts
Read a source transcript with word timings.
- Input
- ?projectId=
- Response shape
- { paragraphs[] }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/transcripts' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/generative-jobs
Generate a thumbnail for a clip. Costs 7 credits, refunded on failure.
- Input
- { clipId, kind?: "thumbnail" }
- Response shape
- { status: "complete", creditsCharged, thumbnailKey }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/generative-jobs' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY" \
--header "Content-Type: application/json" \
--data @request.jsonSave the input fields as request.json before running a write request. Replace path placeholders with your own IDs.
/api/v1/generative-jobs/{clipId}
Read a clip's thumbnail state.
- Response shape
- { clipId, status: "complete" | "none", thumbnailKey }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/generative-jobs/{clipId}' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/censor-jobs
Create a word-censorship job for a clip.
- Input
- { clipId }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/censor-jobs' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY" \
--header "Content-Type: application/json" \
--data @request.jsonSave the input fields as request.json before running a write request. Replace path placeholders with your own IDs.
/api/v1/censor-jobs/{clipId}
Read censorship state for a clip.
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/censor-jobs/{clipId}' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"