REST API · v1
Edit captions
Apply complete caption styles, toggle automatic speaker colors and edit hidden ranges. Range-only changes stay in the draft until you export.
https://polished-turtle-977.convex.siteGet an API keyPUT
/api/v1/clips/{id}/captions/style
Replace the complete style, including the six required fields shown below. Rendering is on by default and spends credits; set rerender to false to save only the draft.
- Input
- { "captionStyle": { "font": "Inter", "fontSize": 40, "primaryColor": "#ffffff", "outlineColor": "#000000", "animationTemplate": "none", "keywordHighlights": [] }, "rerender": false }
- Response shape
- { clipId, status }; 200 draft-only when rerender:false, otherwise 202; additional captionStyle fields follow the current saved template contract
curl --request PUT 'https://polished-turtle-977.convex.site/api/v1/clips/{id}/captions/style' \
--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.
PATCH
/api/v1/clips/{id}/captions
Change one render toggle per request. Hidden ranges use absolute source seconds; add, remove and clear change the draft without starting a render.
- Input
- { "removedRanges": { "add": [{ "startSec": 10, "endSec": 12 }] } }
- Response shape
- { clipId, status, applied[] }; optional speakerColors:boolean | audioEnhance:boolean | autoCensor:boolean (+censorAudioMode:unchanged|bleep|mute); removedRanges:{add?:[{startSec,endSec}],remove?:[{startSec,endSec}],clear?:boolean}; max100ranges per operation, endSec>startSec; export separately with POST /api/v1/clips/{id}/rerender
curl --request PATCH 'https://polished-turtle-977.convex.site/api/v1/clips/{id}/captions' \
--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.