View raw JSON
{
"type": "object",
"required": [
"body"
],
"properties": {
"body": {
"type": "object",
"title": "Input schema for TikTok scraper",
"required": [
"postURLs"
],
"properties": {
"postURLs": {
"type": "array",
"title": "Direct URL(s) for scraping specific video(s)",
"editor": "stringList",
"default": [
"https://www.tiktok.com/@apifylife/video/7200360993149553925"
],
"example": [
"https://www.tiktok.com/@apifylife/video/7200360993149553925"
],
"prefill": [
"https://www.tiktok.com/@apifylife/video/7200360993149553925"
],
"description": "Required list of public TikTok post URL strings. The native default, example and prefill point to one Apifylife sample post; explicitly supply the posts you intend to retrieve. Enter URLs directly in this list."
},
"resultsPerPage": {
"type": "integer",
"unit": "videos",
"title": "💯 Number of related videos per post",
"default": 1,
"example": 100,
"maximum": 1000000,
"minimum": 1,
"prefill": 100,
"description": "Optional cap for related videos for each supplied post URL, used only when scrapeRelatedVideos is true. Integer from 1 to 1,000,000; default 1, with 100 as the form prefill and example. This is not a cap across the whole request or a guaranteed return count."
},
"scrapeRelatedVideos": {
"type": "boolean",
"title": "Scrape related videos",
"editor": "checkbox",
"default": false,
"example": false,
"description": "Optional, false by default. When true, request related videos for the supplied posts, with resultsPerPage limiting related records separately for each input post. This expands the collection beyond the selected original posts.",
"sectionCaption": "🔗 Related videos"
},
"shouldDownloadCovers": {
"type": "boolean",
"title": "Include thumbnails",
"editor": "checkbox",
"default": false,
"example": false,
"description": "Optional, false by default. When true, request downloads of video cover images or thumbnails. This can increase extraction time and cost; use available returned references rather than assume local file delivery."
},
"shouldDownloadVideos": {
"type": "boolean",
"title": "⬇️ Add-on: video download ($)",
"editor": "checkbox",
"default": false,
"example": false,
"description": "Optional charged video-download add-on, false by default. When true, request downloads into Apify storage; videoKvStoreIdOrName can select the storage. Report available returned links without assuming a local file or guaranteed lasting access.",
"sectionCaption": "📹 Download TikTok videos",
"sectionDescription": "You can download scraped TikTok videos to your storage. Links to the downloaded videos will be stored in the dataset (field <code>mediaUrls</code>). Unlike TikTok CDN URLs, they won't expire after scraping has finished. <br> You can also find all downloaded files in the <strong>📦 Storage sidebar → Key-value stores tab</strong>."
},
"videoKvStoreIdOrName": {
"type": "string",
"title": "✍️ Name your storage for videos",
"editor": "textfield",
"example": "tiktok-videos",
"pattern": "^[a-zA-Z0-9-]+$",
"description": "Optional name or ID of the Apify key-value store for downloaded videos and other media. Omit it to use the default store. Names use letters, digits or hyphens without spaces. This selects Apify storage, not a local folder, and does not guarantee permanent retention.",
"resourceType": "keyValueStore",
"resourcePermissions": [
"READ",
"WRITE"
]
},
"downloadSubtitlesOptions": {
"enum": [
"NEVER_DOWNLOAD_SUBTITLES",
"DOWNLOAD_SUBTITLES",
"DOWNLOAD_AND_TRANSCRIBE_VIDEOS_WITHOUT_SUBTITLES",
"TRANSCRIBE_ALL_VIDEOS"
],
"type": "string",
"title": "Subtitles & Transcription",
"editor": "select",
"default": "NEVER_DOWNLOAD_SUBTITLES",
"example": "NEVER_DOWNLOAD_SUBTITLES",
"enumTitles": [
"Don't download subtitles",
"Download subtitles (only when present on the video)",
"Download subtitles + transcribe videos without subtitles (using speech-to-text models) ($)",
"Transcribe all videos (using speech-to-text models) ($)"
],
"description": "Optional. NEVER_DOWNLOAD_SUBTITLES is the default and processes neither subtitles nor transcription. DOWNLOAD_SUBTITLES collects existing subtitles only when present. DOWNLOAD_AND_TRANSCRIBE_VIDEOS_WITHOUT_SUBTITLES collects existing subtitles and uses AI speech-to-text when they are absent. TRANSCRIBE_ALL_VIDEOS uses AI for all input videos. AI transcription incurs an extra charge; accuracy, language and the returned text or reference format are not guaranteed.",
"sectionCaption": "📝 Download TikTok subtitles or transcription ($)",
"sectionDescription": "Choose how to handle subtitles and audio transcription for the input videos."
},
"shouldDownloadSlideshowImages": {
"type": "boolean",
"title": "Download slideshow images",
"editor": "checkbox",
"default": false,
"example": false,
"description": "Optional, false by default. When true, request image downloads for slideshow posts. This can increase collection time and cost; available returned references do not by themselves establish local file delivery."
}
},
"description": "Required request object containing the selected post URLs. Related-video collection, media downloads, storage selection and subtitle or transcription processing are optional choices.",
"schemaVersion": 1
}
},
"additionalProperties": false
}
