Account
Log an account in
Queues the login on the phone the account sits on and returns immediately
with the account moved to pending_login. Works on every platform. Poll
GET /v1/accounts/{account} until the status settles: active when the
phone signed in, needs_verification when the platform challenged it and a
human has to finish on the handset, failed otherwise. Answers 409 when a
login is already in flight — stop it first if you mean to restart it.
Requires stored credentials. Instagram and YouTube accounts may be
record-only — a handle somebody signed in on the handset by hand, with no
username/password here — and those are active and post fine, but the
farm has nothing to type into a login form for them. Answers 422 in that
case; PATCH /v1/accounts/{account} with a username and password first.
path Parameters
accountThe account ID
Log an account in › Responses
AccountResource
Stop a login
Stops the on-phone agent and parks the account as failed with "Login
* stopped.". It does not kill a workflow already running: no login
pipeline re-reads its account between steps, so a run that is mid-flight
finishes and settles its own status over this one. Use it to free a phone
and to move a stuck record off logging_in.
path Parameters
accountThe account ID
Stop a login › Responses
AccountResource
Log an account out
Queues the sign-out on the phone and returns immediately; poll
GET /v1/accounts/{account} until the status becomes logged_out. Works on
TikTok, Instagram and YouTube. A platform flow may decline after it checks
the phone, and the account status remains unchanged in that case. Answers
409 when the account is already logged out.
path Parameters
accountThe account ID
Log an account out › Responses
AccountResource
List accounts
Returns the authenticated user's own posting accounts, newest first, 50 per
page. Every platform is included unless platform narrows it to one.
query Parameters
pagePage number of the paginated result set.
platformOnly accounts on this platform. Omit for every platform, merged.
List accounts › Responses
Paginated set of AccountResource
Create an account
platform chooses where the account posts, and defaults to tiktok.
TikTok. Queues the account for login on a physical phone and returns
immediately. The account is created with status pending_login and is NOT
logged in yet: poll GET /v1/accounts/{account} until its status becomes
active before submitting videos for it. username, password and slot
are all required.
If someone has already signed this account in on the phone by hand, pass
already_signed_in: true. The account is created active and ready to post
immediately, and no login is attempted on the phone. The password is still
required, so the account can be signed back in later if its session drops.
Instagram and YouTube. Only handle is required, and creating one has
three outcomes:
usernameandpasswordsupplied: the account is createdpending_loginand its login is queued on the phone. PollGET /v1/accounts/{account}until the status becomesactive.slotmust name a phone you control, or there is nothing for the login to run on.already_signed_in: true: createdactive, nothing queued. The credentials are still stored so a later re-login can drive the phone.- no credentials: created
activeas a record-only account — a handle somebody signed in on the handset by hand, which the farm holds no way to sign in itself.
device_id is a legacy TikTok-only field and is rejected here rather than
silently dropped.
Create an account › Request Body
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.
Create an account › Responses
AccountResource
Get an account
Works for an account on any platform — the id alone identifies it. Use this
to poll an account's login status after creating it, or after queueing a
login with POST /v1/accounts/{account}/login.
path Parameters
accountThe account ID
Get an account › Responses
AccountResource
Update an account
Only the supplied fields are changed. The account's platform is fixed at creation and cannot be changed here.
Every platform stores credentials, so username and password can be
rotated on all three. What differs is that on Instagram and YouTube
handle must not be blanked when it is sent (nothing discovers it for us,
so it is the only name the account has), slot may be set to null to
detach the account from its phone, and device_id — a legacy TikTok-only
column — is rejected rather than silently dropped.
Rotating a password never re-triggers a login on any platform: an update is
a record edit, and a PATCH that starts driving a handset is a surprise.
Queue one explicitly with POST /v1/accounts/{account}/login when the new
credentials should be used.
path Parameters
accountThe account ID
Update an account › Request Body
handleusernamepasswordslotdevice_idLegacy iMouse field.
notesUpdate an account › Responses
AccountResource

