REST API · v1
Account & setup
Who the caller is, what plan and credits they have, and the onboarding checklist. GET /me/setup is the source of truth an agent follows: each row names its fix, and the fix is either an action link (a page the user opens) or an API call.
https://polished-turtle-977.convex.siteGet an API key/api/v1/me
The signed-in account.
- Response shape
- { id, email, displayName, plan: { tier, status, renewsAt, trialEndsAt, cancelAtPeriodEnd }, credits: { balance, monthlyAllowance, unlimited }, timezone, apiAccess, createdAt }
Available to free accounts.
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/me' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/me/usage
Credit, storage, concurrency and channel usage.
- Response shape
- { credits: { balance, monthlyAllowance, unlimited, usedThisPeriod, periodEndsAt, nextExpiresAt }, storage: { usedBytes, quotaBytes }, concurrentJobs: { active, max }, channels: { used, max } }
Available to free accounts.
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/me/usage' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/me/setup
The setup checklist: the same rows the web, iOS and Android apps show on the Earn tab, with English copy and an action link per row, plus two informative extras.
- Response shape
- { earnState, globalPaused, checklist: [{ id, tier, status, title, detail, fixAction?, actionLink, tool?, desktopOnly, missingPlatforms? }], extras: [{ id, done, detail }], nextStep, complete }
Available to free accounts.
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/me/setup' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/me/credits/history
Credit ledger, newest first.
- Input
- ?limit=&cursor=
- Response shape
- { data: [{ at, delta, reason, kind, jobId? }], nextCursor }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/me/credits/history' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/me/defaults
Saved submit defaults (null when never saved).
- Response shape
- { reframeMode, layoutMode, outputAspect, captionStyle, clipLengthPreference, maxClips, autoHook, autoEnhance, seriesDetection }
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/me/defaults' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"/api/v1/me/defaults
Merge new submit defaults into the saved ones.
- Input
- any of the /me/defaults fields
- Response shape
- the updated defaults
curl --request PUT 'https://polished-turtle-977.convex.site/api/v1/me/defaults' \
--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/me/settings
Posting time zone, notification and watermark preferences.
- Input
- { timezone?: IANA zone, notifications?: { notifyOnNewUpload? }, watermark?: { watermarkForCredits? } }
- Response shape
- { timezone, notifications, watermark }
curl --request PUT 'https://polished-turtle-977.convex.site/api/v1/me/settings' \
--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/me/export
Export your account data, returned inline.
- Input
- {}
- Response shape
- { status: "ready", data }
curl --request POST 'https://polished-turtle-977.convex.site/api/v1/me/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.
/api/v1/plans
The plan and credit-pack catalog the pricing page uses.
- Response shape
- { plans: [{ id, name, priceUsdMonthly, priceUsdYearly, creditsMonthly, features[] }], topups: [{ id, credits, priceUsd }] }
Available to free accounts.
curl --request GET 'https://polished-turtle-977.convex.site/api/v1/plans' \
--header "Authorization: Bearer $AUTOCLIP_API_KEY"