AutoClip

REST API · v1

Auto Clean

Check availability, review every proposed cut, then quote a separate export. Keep the same operation ID and settings when recovering a lost response.

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

/api/v1/cleanup-projects

Recent projects

Input
optional ?clipId= to inspect source capabilities
Response shape
{plans[]} or {available,detectAvailable,renderAvailable,scopeKey,reason,maxSourceDurationSec,maxResolution,badTakesAvailable,multipartAvailable}
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/cleanup-projects' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
POST

/api/v1/cleanup-projects

Analyze video

Input
{clipId,operationId,expectedScopeKey,options:{fillers,stutters,pauses,pauseThresholdSec,badTakes,fillerIntensity?,pauseIntensity?}}
Response shape
{planId,status,selectionVersion,proposalCount,selectedCount,semanticStatus,deduplicated}
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/cleanup-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/cleanup-projects/{id}

Ready for review

Response shape
{planId,sourceClipId,scopeKey,status,options,selectionVersion,proposalCount,selectedCount,semanticStatus,stale,errorCode?}
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/cleanup-projects/{id}' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
GET

/api/v1/cleanup-projects/{id}/proposals

Review cuts

Input
?afterOrder=-1&limit=100 (1–100)
Response shape
{page:[{proposalId,type,startSec,endSec,durationSec,snippet,context,selected}],isDone,nextOrder}
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/cleanup-projects/{id}/proposals' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
PATCH

/api/v1/cleanup-projects/{id}/selection

Remove this cut

Input
{expectedSelectionVersion,change:{type:'toggle',proposalId,selected}|{type:'all',selected}|{type:'ids',ids}}
Response shape
{planId,status,selectionVersion,proposalCount,selectedCount}
curl --request PATCH 'https://polished-turtle-977.convex.site/api/v1/cleanup-projects/{id}/selection' \
  --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/cleanup-projects/{id}/quote

Export selected cuts

Response shape
{quoteId,available,supported,reason,scopeKey,selectionVersion,selectedCount,estimatedCredits,billingMode,output,limits,tariffVersion,costPlanning}
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/cleanup-projects/{id}/quote' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"
POST

/api/v1/cleanup-projects/{id}/renders

Export selected cuts

Input
{operationId,expectedScopeKey,expectedSelectionVersion,quoteId,maxCredits}
Response shape
{renderId,planId,status,estimatedCredits,reservedCredits,chargedCredits,refundedCredits,deduplicated}
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/cleanup-projects/{id}/renders' \
  --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/cleanup-renders/{id}

View cleaned video

Response shape
{renderId,planId,status,outputClipId?,outputDurationSec?,outputWidth?,outputHeight?,chargedCredits,refundedCredits,errorCode?}
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/cleanup-renders/{id}' \
  --header "Authorization: Bearer $AUTOCLIP_API_KEY"