Submission
List video submissions
Returns the authenticated user's own submissions, newest first, 50 per page.
query Parameters
pageplatformThe platform an account posts to, or a submission is published on. Defaults to tiktok when omitted.
List video submissions › Responses
Paginated set of SubmissionResource
Submit a video
Uploads the video and queues it for publishing. Pass platform to choose
tiktok (the default), instagram or youtube, and account_id to name
the account, which must be assigned to a phone.
This returns 201 with status pending (or scheduled when scheduled_at
is set); publishing happens afterwards, so poll
GET /v1/submissions/{submission} for the outcome, or pass webhook_url
to be called when it finishes.
To post one clip to several accounts at once, use
POST /v1/submissions/batches instead.
On YouTube, caption is the Short's title: required, and capped at 100
characters instead of 2200.
Submit a video › Request Body
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.
Submit a video › Responses
SubmissionResource
Get a video submission
Poll this to track a submission's progress. When status is failed,
the failure object describes the step that failed.
path Parameters
submissionThe submission ID
Get a video submission › Responses
SubmissionResource
Delete a video submission
Deletes the submission and its stored video file. Returns 409 unless the
submission has reached a terminal status (published, drafted,
failed or cancelled): work already queued on a phone cannot be
deleted mid-flight.
path Parameters
submissionThe submission ID
Delete a video submission › Responses
No content
Cancel a submission
Cancels a queued or in-progress submission. Returns 403 if the caller does not own it, 404 if it does not exist, and 409 if it has already reached a terminal status.
path Parameters
submissionThe submission ID
Cancel a submission › Responses
SubmissionResource

