REST API · v1
Your channels
Channels you want clipped and posted: your own or any public YouTube, Twitch or Kick channel you have the rights to clip. Auto-Earn sources campaign footage on its own and never needs these; channels it manages show managedBy: "autopilot" and can only be changed by stopping the campaign.
https://polished-turtle-977.convex.siteGet an API key/api/v1/channels/search
Search YouTube channels.
- Input
- ?q= &limit= (≤25)
- Response shape
- { data: [{ youtubeChannelId, title, handle, subscriberCount, thumbnailUrl, recentUploadCadence }] }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/channels/search' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/channels/preview
Preview a channel URL before monitoring it.
- Input
- ?url=
- Response shape
- { platform, externalId, title, handle, subscriberCount, recentVideos[] }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/channels/preview' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/channels
Monitor a channel. Confirmation is required when autoClip is true, because every new upload spends credits. Plan channel limits return 403 plan_limit.
- Input
- { url, autoClip?, autoPost?, socialAccountIds?, campaignId?, settings? }
- Response shape
- 201 Channel
This endpoint requires confirmation. Review the action before sending confirm: true.
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/channels' \
--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/channels
Your monitored channels.
- Input
- ?limit= &cursor=
- Response shape
- { data: [{ id, platform, externalId, title, handle, thumbnailUrl, managedBy: "user"|"autopilot", autoClip, autoPost, socialAccountIds[], campaign, settings, lastCheckedAt, lastVideoDetectedAt, jobsCreated7d, createdAt }], nextCursor }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/channels' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/channels/{id}
One channel.
- Response shape
- Channel
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/channels/{id}' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/channels/{id}
Change auto-clip, auto-post, accounts or clip settings. Confirmation is required when turning autoClip on.
- Input
- { autoClip?, autoPost?, socialAccountIds?, settings? }
- Response shape
- Channel
This endpoint requires confirmation. Review the action before sending confirm: true.
curl --request PATCH 'https://polished-turtle-977.convex.site/api/v1/channels/{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/channels/{id}/campaign
Link a channel to a campaign (or unlink with null). 409 campaign_blocked when the campaign doesn't allow it.
- Input
- { campaignId: string | null }
- Response shape
- Channel
curl --request PUT 'https://polished-turtle-977.convex.site/api/v1/channels/{id}/campaign' \
--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/channels/{id}
Stop monitoring a channel.
- 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/channels/{id}' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY" \
--header "Content-Type: application/json" \
--data @request.json/api/v1/channels/{id}/jobs
Jobs created from a channel.
- Input
- ?limit= &cursor=
- Response shape
- { data: Job[] }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/channels/{id}/jobs' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/channels/auto-configure
Apply recommended settings to every channel.
- Input
- {}
- Response shape
- { updated, channels[] }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/channels/auto-configure' \
--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.