Schemas
AccountResource
idplatformWhich platform this account posts to.
handleusernameThe stored login name. Null on a record-only account — one signed in on the handset by hand, which the farm holds no credentials for. The password is never returned on any platform.
slotWhere the account's login stands. Each platform has its own vocabulary; they overlap heavily but are not the same type.
logged_in_atnotescreated_atupdated_atInstagramAccountStatus
Where an Instagram account stands on its phone. Only an active account can publish.
pending_login |
logging_in |
needs_verification Instagram challenged the login and emailed a confirmation code. The code arrives somewhere the farm cannot see, so the account waits here until a person enters it on the handset. Not a failure — one step from active. |
active |
failed |
logged_out |
Platform
The platform an account posts to, and a submission is published on. tiktok is the default everywhere a platform may be omitted, so a client written before this parameter existed keeps working unchanged.
StoreAccountRequest
usernamepasswordslotplatformWhich platform to create the account on. Defaults to tiktok.
handledevice_idLegacy iMouse field.
notesalready_signed_inSomeone already signed this account in on the phone by hand — create it ready to post and skip the login.
StoreSubmissionRequest
videoplatformPlatform to post to. Defaults to tiktok.
account_idThe account to post as.
tik_tok_account_idDeprecated alias for account_id. Still accepted; prefer account_id.
captionThe text posted with the video. On TikTok and Instagram this is the caption and may be up to 2200 characters; omit it to post without one. On YouTube it is the Short's title instead: required, and capped at 100 characters. Omitting it on YouTube is rejected — YouTube names an untitled Short after the date it was uploaded.
draftSubmissionResource
idplatformWhich platform this submission was published to.
account_idcaptiondraftstatusattemptsfailureWhy the publish did not complete, or null unless status is
failed. step names the stage of the publish that failed; message
is what to do about it. Quote the submission id to support for the
underlying detail.
started_atfinished_atcreated_atupdated_atSubmissionStatus
TikTokAccountStatus
UpdateAccountRequest
handleusernamepasswordslotdevice_idLegacy iMouse field.
notesUserResource
idnameemailemail_verified_atYouTubeAccountStatus
Where a YouTube account stands on its phone. Only an active account can publish. A YouTube login is a Google sign-in, so these states describe the standing of the Google account behind the channel.
pending_login |
logging_in |
needs_verification Google challenged the sign-in — two-step verification, a "confirm it's you" prompt, a device check — and the answer arrives somewhere the farm cannot see. The account waits here until a person finishes on the handset. Do not retry it from the API. |
active |
failed The sign-in did not complete. Check the account before trying again — repeated automated attempts against a challenged Google account can get it locked, which no retry recovers. |
logged_out |