Schemas
AccountResource
idplatformWhich platform this account posts to.
handleslotnotescreated_atupdated_atgoogle_emailThe Google account address of this YouTube channel. Only present for YouTube accounts.
BillingRequestResource
request_idstatuspending, approved, declined or failed, or the computed
expired once a pending request has aged out.
to_phonesapproval_urlexpires_atresolved_atBillingSummaryResource
subscribedphonesprice_per_phonemonthlyon_grace_periodstatus is Stripe's own subscription status.
hintPhoneCommandRequest
optexturllevelonPhoneInputRequest
opfxfyfx1fy1fx2fy2stepskeytextPhoneMacroRequest
workflowNamed scalar values for the workflow's {{placeholders}}.
PhoneResource
slotnamevideo_liveinput_presentcan_controlmodelos_versionPhoneRunKind
What was asked for: a stored workflow (macro), a single device command (command), or an agent task (agent).
PhoneRunResource
idslotThe phone slot UUID this run was queued against.
kindWhat was asked for: macro, command or agent.
statusqueued, running, succeeded, failed or cancelled.
labelShort human label: workflow name, command op, or agent task summary.
What the run produced, when it succeeded. Shape depends on kind.
A get_ip or clipboard_get command returns {"value": "..."}.
errorSafe, customer-readable reason when status is failed; else null.
started_atfinished_atcreated_atPhoneRunStatus
A run starts queued, moves to running once it holds the phone, and ends in exactly one of succeeded, failed or cancelled.
Platform
The platform an account posts to, or a submission is published on. Defaults to tiktok when omitted.
RequestPhoneCountChangeAppliedResource
appliedrequest_idfrom_phonesto_phonesnextRequestPhoneCountChangePendingResource
appliedrequest_idapproval_urlfrom_phonesto_phonesexpires_atnextcharge_nowcharge_on_assignmentmonthly_afterpricing_unavailableRequestPhoneCountChangeRequest
accept_termsphonesaddStartRentalRequest
accept_termsphonescountryStartRentalResource
checkout_urlphonesnextStoreAccountRequest
handleplatformWhich platform to create the account on. Defaults to tiktok.
Required for TikTok, capped at 4 accounts per phone. Optional for Instagram and YouTube.
notesThe Google account address. Required for YouTube, rejected on every other platform.
StoreSubmissionBatchRequest
Where to post. One entry per account; the same account may not be listed twice. Accounts must belong to you and be assigned to a phone.
videoVideo file, up to 200 MB. Accepted types: MP4, MOV.
video_urlupload_idcaptionThe caption posted on TikTok and Instagram destinations, up to 2200
characters. Ignored on YouTube, which takes youtube_title instead.
youtube_titleThe Short's title on YouTube destinations, up to 100 characters. Required when any destination is on YouTube.
draftSave as a draft on the phone instead of publishing. Defaults to false.
scheduled_atWhen to publish every post in the drop, as an ISO 8601 timestamp in the future. Omit to publish now.
webhook_urlAn https URL to POST to as each submission in the drop reaches a terminal status. One delivery per submission, not per drop.
StoreSubmissionRequest
platformPlatform 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.
videoVideo file, up to 200 MB. Accepted types: MP4, MOV.
video_urlupload_idcaptionThe text posted with the video. On TikTok and Instagram this is the caption, up to 2200 characters, and optional. On YouTube it is the Short's title instead: required, and capped at 100 characters.
draftscheduled_atWhen to publish, as an ISO 8601 timestamp in the future. Omit to
publish now. A scheduled submission is created with status
scheduled and can be cancelled until it starts.
webhook_urlAn https URL to POST to once the submission reaches a terminal
status (published, drafted, failed or cancelled). See the
Webhooks section of the introduction for the payload and signature.
SubmissionBatchResource
idcaptionThe caption as given; each submission carries what its platform received.
youtube_titledraftscheduled_atwebhook_urlrunningWhether any post in the drop is still scheduled, queued or running.
created_atupdated_atOne submission per destination, in the order they were given.
SubmissionResource
idplatformWhich platform this submission was published to.
account_idbatch_idThe drop this was created as part of by POST /v1/submissions/batches,
or null for a submission created on its own.
captiondraftstatusattemptsfailureWhy the publish did not complete, or null unless status is
failed. step names the stage that failed; message is what to do
about it. Quote the submission id when contacting support.
scheduled_atWhen this will publish, or null if it was queued immediately.
webhook_urlWhere the completion webhook is delivered, or null if none was asked for.
started_atfinished_atcreated_atupdated_at
