API reference //

• namestringrequiredmin length 1, max length 120
• account_idsuuid[]requiredmin items 2, max items 20

• account_iduuidrequired

• iduuidrequired
• namestringrequired
• account_idsuuid[]required
• created_atdatetimerequired

• namestringrequired
• platformstringrequired
• account_idsuuid[]required

• namestringrequiredmin length 1, max length 120

• iduuidrequired
• brand_iduuidrequired
• platformstringrequired
• usernamestring | nullrequired
• display_namestring | nullrequired
• localestring | nullrequired
• optimize_timingbooleanrequired
• timezonestring | nullrequired
• statusAccountStatusrequired
• group_iduuid | null

  Language-version group this account belongs to.

• removed_atdatetime | null

  Set when removed from this workspace.

• managedbooleanrequired

  True: disconnected at the provider and no longer billed. False: only hidden here.

• scheduled_posts_only_this_accountintegerrequired
• scheduled_posts_sharedintegerrequired
• in_groupbooleanrequired

• removedbooleanrequired
• managedbooleanrequired
• cancelled_postsintegerrequired

One of: connected, disconnected, paused

• localestring | nullmax length 16

  BCP-47, e.g. es-ES

• optimize_timingboolean | null

  Let Fifty Eight test and pick the best posting times for this account

• timezonestring | nullmax length 64

  IANA zone of the audience, e.g. Europe/Paris

• enabledbooleanrequired
• threshold_creditsintegerrequired

  A top-up starts when the balance falls below this.

• amount_centsintegerrequired

  What each automatic top-up charges.

• amount_creditsintegerrequired

  Credits each automatic top-up adds.

• has_payment_methodbooleanrequired

  A card is saved (after a first top-up).

• pendingbooleanrequired

  A top-up is being confirmed by the payment provider.

• kindstringrequired

  comment_answered | comment_skipped | comment_failed | opening_sent | tapped | follow_asked | follow_confirmed | follow_unknown | email_asked | email_invalid | email_collected | link_sent | link_clicked | followup_sent | followup_skipped | expired | step_failed | bound_to_post

• contact_namestring | null
• detailstring | null
• created_atdatetimerequired

• account_iduuidrequired
• namestringrequiredmin length 1, max length 120
• trigger"comment" | "story" | "live"default "comment"

  comment (posts and reels), story (Instagram story replies), live (Instagram)

• status"live" | "paused" | "draft" | null

  live: answers comments | paused: off | draft: saved, not live yet (incomplete texts allowed). Omitted: from `enabled`.

• post_scope"any" | "post" | "next_post" | null

  any: every post of the account | post: the post in platform_post_id | next_post: the next post published on the account after the automation is created (bound when it goes out). Omitted: from platform_post_id.

• platform_post_idstring | nullpattern ^[A-Za-z0-9_:-][A-Za-z0-9_:.-]{0,127}$

  Platform id of one post; omit for every post of the account

• keywordsstring[]max items 20

  Empty: any comment triggers it

• match_mode"word" | "contains"default "word"
• dm_messagestring | nullmax length 640

  The DM with the link (Instagram, Facebook): the last DM of the conversation. {{first_name}}, {{name}}, {{username}}

• button_titlestring | nullmax length 20
• button_urlstring | nullmax length 2000
• public_replystring | nullmax length 1000

  A single public reply under the comment (same as public_replies with one entry)

• public_repliesstring[] | nullmax items 3

  Up to 3 different public replies under the comment: one is picked at random for each comment, so the replies under a post don't all look the same. Takes precedence over public_reply.

• opening_dmOpeningDM | null
• follow_gateFollowGate | null
• email_captureEmailCapture | null
• follow_upFollowUp | null
• link_trackingbooleandefault true

  Count clicks on the link button (through our redirect)

• enabledbooleandefault true

• emailstringrequired
• contact_namestring | nullrequired
• contact_usernamestring | nullrequired
• collected_atdatetimerequired

• comment_idstringrequired
• platform_post_idstring | nullrequired
• commenter_namestring | nullrequired
• comment_textstring | nullrequired
• outcomestringrequired
• dm_sentbooleanrequired
• repliedbooleanrequired
• reply_variantinteger | null

  Which of public_replies was posted (0-based)

• billedstring | nullrequired
• errorstring | nullrequired
• created_atdatetimerequired

• iduuidrequired
• account_iduuidrequired
• platformstringrequired
• account_usernamestring | nullrequired
• namestringrequired
• triggerstringrequired
• status"live" | "paused" | "draft"required
• post_scope"any" | "post" | "next_post"required
• platform_post_idstring | nullrequired

  The post it answers on (next_post: once bound)

• bound_atdatetime | null

  next_post: when the next post was found

• keywordsstring[]required
• match_modestringrequired
• dm_messagestring | nullrequired
• button_titlestring | nullrequired
• button_urlstring | nullrequired
• public_replystring | nullrequired

  The first of public_replies

• public_repliesstring[]required

  Public replies; one is picked at random for each comment

• opening_dmOpeningDM | null
• follow_gateFollowGate | null
• email_captureEmailCapture | null
• follow_upFollowUp | null
• link_trackingbooleandefault false
• enabledbooleanrequired

  status == live

• created_atdatetimerequired
• statsAutomationStatsrequired

• matchedintegerdefault 0

  Comments that matched

• sentintegerdefault 0

  Comments answered (same as runs)

• dmsintegerdefault 0

  Comments answered with a DM

• public_repliesintegerdefault 0
• skippedintegerdefault 0
• failedintegerdefault 0
• runsintegerdefault 0

  Comments answered: what counts against the quota

• dms_sentintegerdefault 0

  Every DM sent, every step of every conversation

• links_sentintegerdefault 0

  People who got the DM with the link

• clicksintegerdefault 0

  People who opened the link (once per person)

• ctrnumberdefault 0

  clicks / links_sent, 0 to 1

• emailsintegerdefault 0

  Email addresses collected

• followups_sentintegerdefault 0

• namestring | nullmin length 1, max length 120
• status"live" | "paused" | "draft" | null

  live: answers comments | paused: off | draft: saved, not live yet (incomplete texts allowed)

• post_scope"any" | "post" | "next_post" | null

  any: every post of the account | post: the post in platform_post_id | next_post: the next post published on the account after the automation is created (bound when it goes out)

• platform_post_idstring | nullpattern ^[A-Za-z0-9_:-][A-Za-z0-9_:.-]{0,127}$
• keywordsstring[] | nullmax items 20
• match_mode"word" | "contains" | null
• dm_messagestring | nullmax length 640
• button_titlestring | nullmax length 20
• button_urlstring | nullmax length 2000
• public_replystring | nullmax length 1000
• public_repliesstring[] | nullmax items 3

  Up to 3 different public replies under the comment: one is picked at random for each comment, so the replies under a post don't all look the same. Takes precedence over public_reply.

• opening_dmOpeningDM | null
• follow_gateFollowGate | null
• email_captureEmailCapture | null
• follow_upFollowUp | null
• link_trackingboolean | null
• enabledboolean | null

  true: live, false: paused (status wins when both sent)

• modestringrequired

  internal | plan | credits | free

• usedintegerrequired
• includedinteger | nullrequired

  Replies included this month; null = unlimited

• per_videointeger | nullrequired

  Replies per video; null = no per-video limit

• addonstring | null

  Legacy Auto-DM add-on still on the plan, if any.

• addon_dmsintegerdefault 0
• triggersstring[]required
• skipped_this_monthintegerrequired
• paid_dmsintegerdefault 0

  Replies past the quota this month, paid in credits.

• dms_per_creditintegerdefault 20

  Replies past the quota paid by one credit.

• credits_this_monthintegerdefault 0

  Credits used by auto-DMs this month.

• namestringrequiredmin length 1, max length 120
• default_localestring | nullmax length 16

• iduuidrequired
• namestringrequired
• default_localestring | nullrequired
• created_atdatetimerequired

• used_centsintegerrequired
• limit_centsinteger | nullrequired

  Null = no limit.

• reachedbooleanrequired

  The next automatic top-up would pass the budget.

• iduuidrequired
• source_media_iduuidrequired
• start_secondsnumberrequired
• end_secondsnumberrequired
• verticalbooleanrequired
• statusstringrequired
• media_iduuid | nullrequired
• media_urlstring | nullrequired
• errorstring | nullrequired
• created_atdatetimerequired

• startnumberrequired≥ 0.0

  Seconds from the start of the video

• endnumberrequired> 0.0

• media_iduuidrequired
• clipsClipRange[]requiredmin items 1, max items 20
• verticalbooleandefault false

  Crop to 9:16 for Reels, TikTok and Shorts

• auth_urlstringrequired
• brand_iduuidrequired

• platform"instagram" | "tiktok" | "youtube" | "facebook" | "linkedin" | "twitter" | "threads" | "pinterest" | "bluesky" | "googlebusiness" | "telegram"required
• brand_iduuid | null

• credit_price_centsintegerrequired

  Price of one credit in US cents (6 = $0.06).

• dub_per_secondintegerrequired

  Credits per second of video, per language.

• lipsync_per_secondnumberrequired

  Extra credits per second of lip-synced video, per language.

• previewintegerrequired

  Credits for a 15-second voice preview.

• subtitles_includedbooleandefault true

  Subtitles without dubbing (original or translated) are included in the plan.

• dms_per_creditintegerrequired

  Auto-DMs past the monthly quota paid by one credit.

• account_per_monthintegerrequired

  Credits a month for each account past the plan (taken daily).

• topup_presetsinteger[]required

  Top-up sizes offered, in credits.

• min_topup_centsintegerrequired
• max_topup_centsintegerrequired

• iduuidrequired
• created_atdatetimerequired
• reasonstringrequired

  subscription | topup | purchase | grant | adjustment | conversion | dub_reserve | dub_refund | lipsync | lipsync_refund | autodm | accounts

• labelstringrequired

  What it was, in words.

• creditsintegerrequired

  Credits added (positive) or used (negative).

• balance_afterintegerrequired
• amount_centsinteger | null

  What a top-up charged, in US cents.

• refstring | null

  Linked object: the dub id (dub_reserve/dub_refund), the auto-DM event id, lipsync:<variant>, the payment (dodo:<id>), or accounts:<workspace>:<day>.

• secondsintegerrequired
• languagesintegerrequired
• dubbingintegerrequired

  Credits for the dub itself.

• lipsyncintegerrequired

  Extra credits for lip sync.

• totalintegerrequired
• balanceintegerrequired
• unlimitedbooleandefault false
• enoughbooleanrequired

  The balance covers it (always true for an internal workspace).

• itemsCreditEntryOut[]required
• totalintegerrequired

• credits_balanceintegerrequired

  Credits left: plan credits and bought credits in one balance. May be below zero after daily account fees.

• dub_seconds_balanceintegerrequired

  Deprecated alias of credits_balance.

• unlimitedbooleandefault false

  Internal workspace: never charged, never blocked.

• plan_credits_per_monthintegerdefault 0

  Credits the current plan adds each paid month.

• next_plan_credits_atdatetime | null

  When the plan adds its next credits.

• accounts_past_planintegerdefault 0

  Connected accounts that cost credits.

• accounts_pausedintegerdefault 0

  Accounts past the plan paused because the credits could not pay for them.

• costsCostsOut | null
• auto_topupAutoTopupOut | null
• budgetBudgetOut | null
• caption_translationbooleandefault false
• limitsLimitsOut | null
• modestringdefault "free"
• walletWalletOut | null

  Deprecated: see auto_topup and budget.

• dubbing_enabledbooleandefault true
• activebooleandefault true
• lipsyncLipsyncRatesOut | null

• plan_idstring | nullrequired
• statusstring | nullrequired
• renews_atdatetime | nullrequired
• can_managebooleanrequired
• rolestringdefault "member"

• media_iduuidrequired

  The video of the post.

• source_languagestring | nullpattern ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})?$

  Omit to auto-detect.

• languagesstring[]requiredmin items 1, max items 16
• targetsmap<string, uuid[]>required

  For each language, the accounts that get that language version. Every language needs one.

• subtitlesbooleandefault true
• subtitle_styleSubtitleStyle | null
• lipsyncbooleandefault false
• duration_secondsinteger | null≥ 1.0, ≤ 36000.0

  The video's length as measured by the client (credits check).

• tiktokTikTokOptions | null
• youtube_titlestring | nullmax length 100

• postPostCreate | null

  The original post. Omit to only publish the dubs.

• dubDubPlanInrequired

• postPostOut | nullrequired
• dubLocalizationOutrequired

• messagestringdefault "What's your email address, {{first_name}}? I'll send you the link right after."min length 1, max length 640
• invalid_messagestringdefault "Hmm, that doesn't look like an email address. Could you send it again?"min length 1, max length 640

• format"feed" | "reel" | "story"default "feed"

  reel: a single vertical video. story: one photo or video, 24 hours, no caption.

• titlestring | nullmax length 255

  Reel title.

• messagestringdefault "Almost there, {{first_name}}! Follow us first, then tap the button below."min length 1, max length 640
• button_titlestringdefault "I'm following"min length 1, max length 20

• messagestringrequiredmin length 1, max length 640

  {{first_name}}, {{name}}, {{username}}

• delay_hoursintegerdefault 4≥ 1.0, ≤ 23.0

• format"auto" | "story"default "auto"

  auto: images go to the feed (several make a carousel), a single video is a Reel. story: a Story (one photo or video, 24 hours, no caption).

• share_to_feedbooleandefault true

  Reels: also show it in the feed (false: Reels tab only).

• collaboratorsstring[]max items 3

  Up to 3 @usernames of public creator or business accounts.

• paid_partnershipbooleandefault false

  Show the 'Paid partnership' label.

• plan_idstring | nullrequired
• accountsintegerrequired
• languagesintegerrequired
• accounts_usedintegerrequired
• extra_accountsintegerdefault 0

• disable_link_previewbooleandefault false

• languagesstring[] | nullmax items 16

  Languages to lip-sync. Omit for every ready language.

• credit_multipliernumberrequired
• max_secondsintegerrequired

• media_iduuidrequired

  An uploaded video (see POST /v1/media/uploads).

• languagesstring[]requiredmin items 1, max items 16

  BCP-47 tags to dub into, e.g. es, pt-BR, ja

• source_languagestring | nullpattern ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})?$

  Omit to auto-detect.

• captionstringdefault ""max length 5000

  Caption to translate for each language.

• subtitlesbooleandefault true

  Burn each language's subtitles into its dubbed video.

• lipsyncbooleandefault false

  Also lip-sync each language once dubbed: +1.5 credits per second of video, per language (rounded up per job).

• subtitle_styleSubtitleStyle | null

  Look of the burned subtitles. Omit for the workspace's last style (or Pop).

• previewbooleandefault false

  Dub only the first 15 seconds into one language to hear the voice first (15 credits).

• duration_secondsinteger | null≥ 1.0, ≤ 36000.0

  The video's length as the client measured it, so a dub the balance can't cover is refused up front. The exact cost is taken once the video is measured on our side.

• iduuidrequired
• source_media_iduuidrequired
• source_languagestring | nullrequired
• captionstringrequired
• statusstringrequired
• duration_secondsinteger | nullrequired
• errorstring | nullrequired
• sourcestringrequired
• burn_subtitlesbooleandefault false
• lipsyncbooleandefault false

  Lip sync was asked for at dub time.

• subtitle_styleobject | null

  Style of the burned subtitles.

• original_post_iduuid | null

  Post this dub was started from, if any.

• previewbooleandefault false

  A 15-second sample, never published.

• created_atdatetimerequired
• updated_atdatetimerequired
• variantsVariantOut[]required

• account_idsuuid[] | null

  Limit to these accounts. Default: every connected account.

• include_originalbooleandefault true

  Also post the original video to accounts in the source language or with no language set.

• publish_nowbooleandefault false
• scheduled_fordatetime | null
• timezonestring | null
• draftbooleandefault false
• tiktok_consentbooleandefault false
• tiktok_privacy"PUBLIC_TO_EVERYONE" | "MUTUAL_FOLLOW_FRIENDS" | "FOLLOWER_OF_CREATOR" | "SELF_ONLY"default "PUBLIC_TO_EVERYONE"
• youtube_titlestring | nullmax length 100
• idempotency_keystring | nullmax length 64

• media_iduuid | null
• urlurl | nullmin length 1, max length 2083
• type"video" | "image" | null

• idstringrequired
• account_iduuidrequired
• platformstringrequired
• account_usernamestring | nullrequired
• namestringrequired
• triggerstringrequired
• platform_post_idstring | nullrequired
• post_titlestring | nullrequired
• keywordsstring[]required
• match_modestringrequired
• dm_messagestring | nullrequired
• button_titlestring | nullrequired
• button_urlstring | nullrequired
• public_replystring | nullrequired
• enabledbooleanrequired
• created_atstring | nullrequired
• statsNativeAutomationStatsrequired
• runs_onstringdefault "zernio"

• triggeredintegerdefault 0
• dms_sentintegerdefault 0
• dms_failedintegerdefault 0
• unique_contactsintegerdefault 0
• link_clicksintegerdefault 0
• unique_clicksintegerdefault 0

• namestring | nullmin length 1, max length 120
• keywordsstring[] | nullmax items 20
• match_mode"word" | "contains" | "exact" | null
• dm_messagestring | nullmax length 640
• button_titlestring | nullmax length 20
• button_urlstring | nullmax length 2000
• public_replystring | nullmax length 1000
• enabledboolean | null

• messagestringrequiredmin length 1, max length 640

  {{first_name}}, {{name}}, {{username}}

• button_titlestringdefault "Send me the link"min length 1, max length 20

• iduuidrequired
• namestringrequired
• created_atdatetimerequired
• dubbing_enabledbooleandefault true

• idstringrequired
• labelstringrequired
• secondsintegerrequired
• pricestringrequired

• idstringrequired
• namestringrequired

• board_idstring | nullmax length 64

  Board to pin to (see pinterest-boards).

• titlestring | nullmax length 100
• linkurl | nullmin length 1, max length 2083

  Where a click on the pin goes.

• idstringrequired
• labelstringrequired
• creditsintegerrequired

  Credits added each paid month (unused credits roll over).

• secondsintegerrequired

  Deprecated alias of credits.

• pricestringrequired
• accountsintegerrequired
• languagesintegerrequired
• autodm_monthintegerdefault 0
• autodm_per_videointeger | null
• autodm_triggersstring[]default []

• plansPlan[]required
• currentCurrentPlanrequired

• contentstringdefault ""max length 10000
• mediaMediaRef[]max items 20
• targetsTargetIn[]requiredmin items 1, max items 100
• publish_nowbooleandefault false
• scheduled_fordatetime | null

  ISO 8601 with offset, or naive local time interpreted in `timezone`.

• timezonestring | null

  IANA zone, e.g. Europe/Paris

• draftbooleandefault false
• fixed_timebooleandefault false

  Never let the best-time optimizer move this post (e.g. a launch at a set hour)

• tiktok_consentbooleandefault false

  Needed when the copy targets a TikTok account.

• iduuidrequired
• brand_iduuidrequired
• contentstringrequired
• mediaany[]required
• publish_nowbooleanrequired
• scheduled_fordatetime | nullrequired
• timezonestring | nullrequired
• statusPostStatusrequired
• errorstring | nullrequired
• sourcestringrequired
• fixed_timebooleanrequired
• can_retrybooleanrequired
• published_atdatetime | null
• created_atdatetimerequired
• updated_atdatetimerequired
• targetsTargetOut[]required

One of: draft, scheduled, publishing, published, partially_published, failed, cancelled, held

• importedintegerrequired
• updatedintegerrequired
• removedintegerrequired
• brandsintegerrequired

• contentstring | nullmax length 10000
• mediaMediaRef[] | nullmax items 20

  The full new media list, in order.

• targetsTargetEdit[] | nullmin items 1, max items 100

  The full new set of accounts, with their captions.

• scheduled_fordatetime | null

  New time: ISO 8601 with offset, or naive local time interpreted in `timezone`.

• timezonestring | null
• draftboolean | null

  true: keep or make it a draft. false: schedule it.

• fixed_timeboolean | null

  Never let the best-time optimizer move this post.

• subtitle_styleSubtitleStyle | null

  Change the look before burning.

• media_iduuidrequired

  An uploaded video (see POST /v1/media/uploads).

• languagestring | nullpattern ^[a-z]{2,3}(-[A-Za-z0-9]{2,8})?$

  Spoken language. Omit to detect it.

• translate_tostring[]max items 7

  Also burn subtitles translated into these languages (same audio).

• subtitle_styleSubtitleStyle | null

  Look of the subtitles. Omit for the workspace's last style (or Pop).

• reviewbooleandefault false

  Stop once the transcript is ready so it can be corrected (PATCH .../transcript), then POST .../confirm to burn it.

• captionstringdefault ""max length 10000
• duration_secondsinteger | null≥ 1.0, ≤ 36000.0

  The video's length as the client measured it (length check).

• publishSubtitlePublishPlan | null

  Publish each version once it is ready.

• iduuidrequired
• source_media_iduuidrequired
• languagestring | nullrequired
• language_detectedbooleanrequired
• statusstringrequired
• errorstring | nullrequired
• sourcestringrequired
• captionstringrequired
• reviewbooleanrequired
• duration_secondsinteger | nullrequired
• subtitle_styleobject | null
• created_atdatetimerequired
• updated_atdatetimerequired
• finished_atdatetime | null
• variantsSubtitleVariantOut[]required
• queueSubtitleQueueOut | null

• contentstringdefault ""max length 10000

  Caption (translated for each other language).

• originalTargetIn[]max items 100
• languagesmap<string, TargetIn[]>

  Translated language -> its accounts (with their platform options).

• publish_nowbooleandefault false
• scheduled_fordatetime | null
• timezonestring | null
• draftbooleandefault false

  Make draft posts instead of publishing.

• fixed_timebooleandefault false

• stage"transcribe" | "burn" | nullrequired

  Queue the job waits in (null: not waiting).

• aheadintegerrequired

  Videos that will be handled before this one in that queue.

• eta_secondsinteger | nullrequired

  Estimated seconds until this video is ready (recent averages).

• subtitle_styleSubtitleStylerequired

• preset"pop" | "bold_box" | "clean" | "karaoke" | "minimal" | "classic"default "pop"

  pop: 2-3 big words, the spoken word pops in colour. bold_box: words on a solid colour box. clean: sentence case, soft fade. karaoke: words fill with colour as spoken. minimal: small lowercase. classic: plain line-level subtitles.

• font"poppins" | "montserrat" | "anton" | "bebas" | "archivo" | "rounded" | "noto" | null

  Omit for the preset's font.

• highlight"indigo" | "brand" | "yellow" | "green" | "red" | "pink" | "white" | "black"default "indigo"
• text_color"indigo" | "brand" | "yellow" | "green" | "red" | "pink" | "white" | "black"default "white"
• position"bottom" | "middle" | "top"default "bottom"
• size"s" | "m" | "l"default "m"
• uppercaseboolean | null

  Omit for the preset's default.

• languagestringrequired
• originalbooleanrequired
• statusstringrequired
• media_iduuid | nullrequired
• media_urlstring | null

  Subtitled video. Temporary link, kept 7 days.

• captionstring | nullrequired
• errorstring | nullrequired
• post_iduuid | null
• publish_notestring | null

• account_iduuidrequired
• contentstring | null

  Caption for this account only (null: the main caption).

• tiktok_consentbooleandefault false

  Required when adding a TikTok account: the creator reviewed and consents.

• account_iduuidrequired
• contentstring | null

  Override the caption for this account.

• tiktokTikTokOptions | null
• youtube_titlestring | nullmax length 100

  Same as youtube.title (older name).

• first_commentstring | nullmax length 5000

  Instagram, Facebook, LinkedIn, YouTube and Threads (500).

• instagramInstagramOptions | null
• youtubeYouTubeOptions | null
• pinterestPinterestOptions | null
• facebookFacebookOptions | null
• xXOptions | null

  X (twitter accounts).

• threadsThreadsOptions | null
• linkedinLinkedInOptions | null

• iduuidrequired
• social_account_iduuidrequired
• platformstringrequired
• custom_contentstring | nullrequired
• platform_optionsobject

  The platform options sent for this account.

• statusTargetStatusrequired
• platform_post_urlstring | nullrequired
• platform_post_idstring | null

  Published posts: the post's id on the platform (use it to bind an automation).

• error_messagestring | nullrequired
• error_categorystring | nullrequired
• published_atdatetime | null
• metricsobject | null

  Published posts: latest views, likes, comments, shares, saves, reach, impressions.

One of: pending, publishing, published, failed, cancelled, held

• topic_tagstring | nullmin length 1, max length 50, pattern ^[^.&]+$

• topicstringdefault "other"

  One of: billing, dubbing, publishing, automations, accounts, api, bug, privacy, other.

• messagestringrequiredmin length 1, max length 5000
• media_iduuid | null

  An uploaded screenshot (see POST /v1/media/uploads).

• emailstring | null

  Where we answer. Defaults to your account email.

• numberstringrequired
• topicstringrequired
• statusstringrequired
• messagestringrequired
• created_atdatetimerequired

• privacy_level"PUBLIC_TO_EVERYONE" | "MUTUAL_FOLLOW_FRIENDS" | "FOLLOWER_OF_CREATOR" | "SELF_ONLY"default "PUBLIC_TO_EVERYONE"
• allow_commentbooleandefault true
• allow_duetbooleandefault true

  Videos only.

• allow_stitchbooleandefault true

  Videos only.

• commercial_content"none" | "brand_organic" | "brand_content"default "none"

  Disclose commercial content: brand_organic (promotes your own brand) or brand_content (a paid partnership). Not allowed with privacy SELF_ONLY.

• draftbooleandefault false

  Send to the creator's TikTok inbox as a draft instead of publishing: the creator finishes and posts it in the TikTok app.

• consentbooleandefault false

  Must be true: the creator reviewed the content and agrees to publish it.

• account_iduuidrequired
• platformstringrequired
• usernamestring | nullrequired
• optimize_timingbooleanrequired
• timezonestring | nullrequired

  Audience zone; slots are computed in UTC until it is set

• posts_analyzedintegerrequired
• confidencestringrequired

  learning (<15 posts), medium (<50) or high

• best_slotsTimingSlot[]required
• gridnumber[][]required

  Expected lift per weekday (rows, Monday first) and time block

• blocksstring[]required
• daysstring[]required
• accountsTimingAccount[]required
• movesTimingMoveOut[]required

• post_iduuidrequired
• original_atdatetimerequired
• planned_atdatetimerequired
• expected_gainnumberrequired
• appliedbooleanrequired
• errorstring | nullrequired
• created_atdatetimerequired
• previewstringrequired
• timezonestring | null

• labelstringrequired
• weekdayintegerrequired
• blockintegerrequired
• liftnumberrequired

  Expected performance vs the account's median, log scale (+0.3 ~ +35 %)

• sdnumberrequired

• linesobject[]requiredmin items 1, max items 2000

  [{"index": 3, "text": "corrected words"}] (line indexes from GET).

• indexintegerrequired
• startnumberrequired
• endnumberrequired
• textstringrequired

• languagestringrequired
• editablebooleanrequired

  True while the job waits for review (original language only).

• linesTranscriptLine[]required

• media_iduuidrequired
• upload_urlstringrequired

  PUT the file bytes here with the same Content-Type. Valid 1 hour.

• public_urlstringrequired

• filenamestringrequiredmin length 1, max length 255
• content_typestringrequiredpattern ^(video|image)/[\w.+-]+$
• size_bytesinteger | null> 0.0, ≤ 5368709120.0

• captionstringrequiredmax length 5000

• languagestringrequired
• statusstringrequired
• media_iduuid | nullrequired
• media_urlstring | null

  Dubbed video. Temporary link, kept 7 days.

• captionstring | nullrequired
• errorstring | nullrequired
• lipsync_statusstring | null

  pending | running | ready | failed (null: none).

• lipsync_errorstring | null
• lipsync_cost_secondsintegerdefault 0

  Credit seconds the latest lip sync attempt took.

• unsynced_media_urlstring | null

  The dubbed video before lip sync, kept to compare or go back.

• post_iduuid | null

  Post made for this language (dubs started from a post).

• publish_notestring | null

  Why this language wasn't published, or a heads-up.

• balance_centsintegerrequired
• auto_topup_enabledbooleanrequired
• auto_topup_threshold_centsintegerrequired
• auto_topup_amount_centsintegerrequired
• auto_topup_monthly_cap_centsinteger | null
• auto_topup_month_centsintegerdefault 0
• auto_topup_cappedbooleandefault false
• has_payment_methodbooleanrequired
• topup_pendingbooleanrequired
• entriesWalletEntryOut[]required

• delta_centsintegerrequired
• reasonstringrequired
• created_atdatetimerequired

• balance_centsintegerrequired
• auto_topup_enabledbooleanrequired
• auto_topup_threshold_centsintegerrequired
• auto_topup_amount_centsintegerrequired
• auto_topup_monthly_cap_centsinteger | null
• auto_topup_month_centsintegerdefault 0
• auto_topup_cappedbooleandefault false
• has_payment_methodbooleanrequired
• topup_pendingbooleanrequired

• iduuidrequired
• namestringrequired
• created_atdatetimerequired
• dubbing_enabledbooleandefault true
• rolestringdefault "member"

• dubbing_enabledboolean | null

  Turn dubbing on or off for this workspace.

• made_with_aibooleandefault false

  Label the post as containing AI-generated media.

• titlestring | nullmax length 100

  Video title (default: the caption's first line).

• visibility"public" | "unlisted" | "private"default "public"
• category_idstringdefault "22"

  YouTube category id, e.g. 22 People & Blogs, 27 Education.

• tagsstring[]max items 50

  Up to 100 characters each, 500 in all.

• made_for_kidsbooleandefault false
• synthetic_mediabooleandefault false

  Discloses altered or synthetic content that looks real (YouTube may label it).