REST API · v1
Clip collections
Organize clips within the active workspace. Favorites uses existing starred clips. The catalog reports create, add, export, and management permissions; custom collections have a 200-collection limit. Membership changes preserve the underlying clips.
https://polished-turtle-977.convex.siteGet an API key/api/v1/collections
List active collections and workspace capabilities.
- Response shape
- { collections[], canCreate, canAdd, canExport, canManage, maxCollections, workspaceId }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/collections' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/collections
Create a collection. Reuse operationId when retrying the same request.
- Input
- { name: 1–40 Unicode characters, operationId: stable 16–100 character ID }
- Response shape
- 201 Collection
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/collections' \
--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/collections/{id}
Rename a custom collection.
- Input
- { name }
- Response shape
- Collection
curl --request PATCH 'https://polished-turtle-977.convex.site/api/v1/collections/{id}' \
--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/collections/{id}
Remove a custom collection while preserving its clips. Favorites cannot be removed.
- Input
- { confirm: true }
- Response shape
- 204 No Content
This endpoint requires confirmation. Review the action before sending confirm: true.
curl --request DELETE 'https://polished-turtle-977.convex.site/api/v1/collections/{id}' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY" \
--header "Content-Type: application/json" \
--data @request.json/api/v1/collections/{id}/clips
List collection clips by cursor. A filtered empty page can still have a continuation cursor.
- Input
- ?limit= (1–100) &cursor=
- Response shape
- { page[], isDone, continueCursor }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/collections/{id}/clips' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/collections/{id}/clips
Add up to 100 workspace clips. Existing memberships are retained without duplication.
- Input
- { clipIds[] }
- Response shape
- { added }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/collections/{id}/clips' \
--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/collections/{id}/clips
Remove up to 100 memberships; the videos remain in the library.
- Input
- { clipIds[] }
- Response shape
- { removed }
curl --request DELETE 'https://polished-turtle-977.convex.site/api/v1/collections/{id}/clips' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY" \
--header "Content-Type: application/json" \
--data @request.json/api/v1/collections/{id}/export
Get signed downloads for ready clips. Use pagination for the collection, or clipIds for a checked selection; do not combine them. Links expire in 15 minutes.
- Input
- { limit?: 1–100, cursor? } or { clipIds[]: 1–100 }
- Response shape
- { files: [{ clipId, fileName, url }], isDone, continueCursor, expiresInSec: 900 }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/collections/{id}/export' \
--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.