REST API · v1
Earn: Auto-Earn
Auto-Earn finds Content Rewards campaigns that fit your accounts, clips only the footage each campaign provides, posts the clips to your linked accounts, and the AutoClip Chrome extension submits each post to Content Rewards. These routes cover everything the Earn tab does. Turning Auto-Earn on also turns on auto-submit; there is no separate switch.
https://polished-turtle-977.convex.siteGet an API key/api/v1/earn/overview
The whole Earn screen: state, checklist, extension status, Content Rewards money, the away digest and settings.
- Response shape
- { state, globalPaused, topIssueId?, checklist[], machine, money, digest?, settings }
Available to free accounts.
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/earn/overview' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/earn/activity
The activity feed: posted, submitted, approved, rejected, missed, attention, joined, skipped.
- Input
- ?limit= (≤100, default 30) &campaignId=
- Response shape
- { data: [{ kind, at, campaignId, campaignName, platform?, handle?, amountCents?, reason?, submissionId?, enrollmentId?, deadlineAt?, fixAction? }], nextCursor: null }. On kind "posting", reason is why the post is waiting (see Auto-Earn reasons below).
Available to free accounts.
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/earn/activity' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/earn/autopilot
Auto-Earn on/off, footage consent, settings, and the exact consent texts to show: consentText (footage) and brandedContentConsentText (TikTok's Paid partnership label).
- Response shape
- { enabled, footageConsented, globalPaused, settings: { maxActiveCampaigns, dailyCreditBudget?, reservedCredits, minCpmCents, platforms?, offlinePolicy, manualProofCampaigns: "skip"|"include", tiktokPaidPartnership, brandedContentConsentAt?, captionAdDisclosure, footageConsented }, consentText, brandedContentConsentText, platformsAvailable[], limits: { maxActiveHardCap: 10 } }
Available to free accounts.
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/earn/autopilot' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/earn/autopilot
Change settings and/or turn Auto-Earn on or off. Settings and turning it off work on any plan; turning it on needs a paid plan (403 paid_plan_required) and footage consent the first time (428 consent_required). Confirmation (428 confirmation_required) is asked when turning Auto-Earn on, when raising what a running Auto-Earn may spend, and when turning tiktokPaidPartnership on: that prompt's summary is brandedContentConsentText, which the user must see before you resend with confirm: true. Turning tiktokPaidPartnership on records when the user accepted. manualProofCampaigns (default "skip") decides whether campaigns needing manual proof or a specific audience are skipped; captionAdDisclosure (default false) adds #ad to campaign captions. All three are the user's choice.
- Input
- { enabled?, footageConsent?, maxActiveCampaigns? (1-10), dailyCreditBudget? (number | null = auto), reservedCredits? (0-100000 credits channel auto-clipping leaves for Auto-Earn; 0 = off), minCpmCents?, platforms?: ("tiktok"|"instagram"|"youtube")[], offlinePolicy?: "wait_then_untagged"|"wait_forever", manualProofCampaigns?: "skip"|"include", tiktokPaidPartnership?: boolean, captionAdDisclosure?: boolean, confirm? }
- Response shape
- { enabled, footageConsented, settings }
This endpoint requires confirmation. Review the action before sending confirm: true.
Available to free accounts.
curl --request PATCH 'https://polished-turtle-977.convex.site/api/v1/earn/autopilot' \
--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/earn/enrollments
Campaigns Auto-Earn is running (or ran) for you.
- Input
- ?status=running|paused|skipped|ended|all
- Response shape
- { data: [{ enrollmentId, campaignId, campaignName, cpmCents, platforms[], status, origin: "autopilot"|"pinned", skipReason, skipDetail, endReason, sourceHint, sources[], submissionsCount, earnedCents, firstActiveAt, updatedAt }], nextCursor: null }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/earn/enrollments' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/earn/enrollments/{id}/stop
Stop running a campaign. Auto-Earn stops clipping and submitting for it.
- Input
- { confirm: true }
- Response shape
- { stopped }
This endpoint requires confirmation. Review the action before sending confirm: true.
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/earn/enrollments/{id}/stop' \
--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/earn/recommendations
Campaigns recommended for Auto-Earn, with expected value per clip and why any are blocked.
- Input
- ?limit= (≤50, default 12)
- Response shape
- { data: [{ campaignId, name, cpmCents, platforms[], evCentsPerClip, sourceHint?, eligible, blocker?, blockerText? }], nextCursor: null }
Available to free accounts.
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/earn/recommendations' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/campaigns/{id}/autopilot-fit
Whether Auto-Earn can run a campaign for you, check by check.
- Response shape
- { eligible, checks: [{ label, ok }], enrollment | null }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/campaigns/{id}/autopilot-fit' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/campaigns/{id}/pin
Auto-earn this campaign: pin a campaign so Auto-Earn runs it. Errors: 409 campaign_ineligible / max_active / autopilot_paused, 403 paid_plan_required, 428 consent_required.
- Input
- {}
- Response shape
- { enrollmentId, autopilotEnabled }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/campaigns/{id}/pin' \
--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/earn/desktop-setup-link
Email the user the desktop setup link (for someone on a phone). Up to 3 a day (429 after that); 409 when the account has no email.
- Input
- {}
- Response shape
- { sent: true, remainingToday, url: "https://autoclip.dev/dashboard/earn?setup=1" }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/earn/desktop-setup-link' \
--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/earn/whop
The optional Whop wallet connection that shows your Content Rewards payout balance inside AutoClip.
- Input
- ?include=memberships
- Response shape
- { connected, account: { username, connectedAt, status } | null, memberships? }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/earn/whop' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/earn/whop
Disconnect the Whop wallet view. Payouts on Content Rewards are not affected.
- 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/earn/whop' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY" \
--header "Content-Type: application/json" \
--data @request.json