REST API · v1
One-call setup
A convenience that applies a whole plan in order (time zone → defaults → Auto-Earn settings → turn on → pins → channels → queue slots) using the same handlers as the individual routes. Use dryRun first to validate and see the daily credit estimate.
https://polished-turtle-977.convex.siteGet an API key/api/v1/autopilot/setup
Apply an AutopilotPlan. Confirmation is required when it turns Auto-Earn on or adds an auto-clip channel; the first enable also needs earn.footageConsent: true. earn.settings can't turn tiktokPaidPartnership on (use PATCH /earn/autopilot, which shows TikTok's terms). It stops on the first hard error (plan, consent, pause) and reports per-step results. Caps: 20 channels, 20 accounts, 10 pins.
- Input
- { plan: { timezone?, defaults?, earn?: { enabled, footageConsent?, settings?, pinCampaignIds? }, channels?: [{ url, autoClip, autoPost, socialAccountIds?, campaignId?, settings? }], queueSlots?: [{ socialAccountId, slots[] }] }, dryRun?, confirm? }
- Response shape
- { applied, results: [{ step, key?, ok, error? }], estimate: { dailyCreditBudget, maxActiveCampaigns, autoClipChannels, creditsBalance }, setup: SetupStatus }
This endpoint requires confirmation. Review the action before sending confirm: true.
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/autopilot/setup' \
--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.