{ "openapi": "3.0.1", "info": { "title": "TikTok Transcript & Video Scraper", "description": "Extract spoken transcripts from TikTok videos as text, SRT or WebVTT with timestamps. Every video also returns 58 fields: upload date, views, likes, saves, hashtags, sounds, and creator follower counts. Pick a caption language, or download watermark-free MP4s. No login needed.", "version": "1.1", "x-build-id": "DFxN7xWhfxd1Aseso" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/dz_omar~tiktok-video-downloader/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-dz_omar-tiktok-video-downloader", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } }, "/acts/dz_omar~tiktok-video-downloader/runs": { "post": { "operationId": "runs-sync-dz_omar-tiktok-video-downloader", "x-openai-isConsequential": false, "summary": "Executes an Actor and returns information about the initiated run in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/runsResponseSchema" } } } } } } }, "/acts/dz_omar~tiktok-video-downloader/run-sync": { "post": { "operationId": "run-sync-dz_omar-tiktok-video-downloader", "x-openai-isConsequential": false, "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.", "tags": [ "Run Actor" ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/inputSchema" } } } }, "parameters": [ { "name": "token", "in": "query", "required": true, "schema": { "type": "string" }, "description": "Enter your Apify token here" } ], "responses": { "200": { "description": "OK" } } } } }, "components": { "schemas": { "inputSchema": { "type": "object", "required": [ "videoUrls" ], "properties": { "videoUrls": { "title": "šŸ”— TikTok Video URLs", "type": "array", "description": "List of TikTok video URLs to process. Supports multiple URL formats:\n\n**Standard URLs:**\n- https://www.tiktok.com/@username/video/1234567890\n\n**Short URLs:**\n- https://vm.tiktok.com/ABC123\n\n**Mobile URLs:**\n- https://m.tiktok.com/v/1234567890", "default": [ { "url": "https://www.tiktok.com/@chasseurdesons/video/7470583049239956758" } ], "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "includeTranscript": { "title": "šŸ“ Extract Transcript (Speech-to-Text)", "type": "boolean", "description": "Extract the spoken words from each video as text.\n\nTikTok auto-generates captions for videos containing speech, and this pulls that track directly. Videos with no speech (music, sound effects) return no transcript, which is normal.\n\nTypical coverage is 60-70% of videos.", "default": true }, "transcriptFormats": { "title": "šŸ“„ Transcript Formats", "type": "array", "description": "Choose which transcript formats to include in the output:\n\n- **Plain text**: the full transcript as one string\n- **Timed segments**: array of lines with start/end times\n- **SRT**: subtitle file content, ready to save as .srt\n- **WebVTT**: the raw caption file exactly as TikTok serves it", "items": { "type": "string", "enum": [ "text", "segments", "srt", "vtt" ], "enumTitles": [ "šŸ“ƒ Plain text", "ā±ļø Timed segments", "šŸŽ¬ SRT subtitles", "šŸŒ WebVTT (raw)" ] }, "default": [ "text", "segments" ] }, "preferredLanguage": { "title": "šŸŒ Preferred Transcript Language", "enum": [ "auto", "eng-US", "spa-ES", "por-BR", "fra-FR", "deu-DE", "ita-IT", "jpn-JP", "kor-KR", "ind-ID", "vie-VN", "tha-TH", "rus-RU", "ara-SA", "tur-TR", "zho-Hans" ], "type": "string", "description": "Language to prefer when a video has more than one caption track.\n\nLeave as **Auto** to use the video's original spoken language. If the requested language is not available, the original track is returned instead.", "default": "auto" }, "preferredFps": { "title": "šŸŽÆ Preferred Frame Rate", "enum": [ "30", "60" ], "type": "string", "description": "Choose your preferred video frame rate:\n\n- **60 FPS**: Higher quality, smoother playback\n- **30 FPS**: Standard quality, smaller files", "default": "60" }, "downloadVideo": { "title": "šŸ“„ Download & Store Video Files", "type": "boolean", "description": "Enable to download and store video files in Apify storage:\n\n- **Disabled**: Only metadata and direct TikTok URLs\n- **Enabled**: Download MP4 files with persistent links\n\nāš ļø **This starts a second Actor.** Downloading is handled by [Universal Downloader](https://apify.com/dz_omar/universal-downloader), so you will see two Actor runs in your account. It bills separately, on top of this Actor's download event. Leave this off if you only need transcripts and metadata.", "default": false }, "proxyConfig": { "title": "šŸ”’ Proxy Configuration", "type": "object", "description": "Configure proxy settings. Residential proxies recommended for better success rates.", "default": { "useApifyProxy": false } } } }, "runsResponseSchema": { "type": "object", "properties": { "data": { "type": "object", "properties": { "id": { "type": "string" }, "actId": { "type": "string" }, "userId": { "type": "string" }, "startedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "finishedAt": { "type": "string", "format": "date-time", "example": "2025-01-08T00:00:00.000Z" }, "status": { "type": "string", "example": "READY" }, "meta": { "type": "object", "properties": { "origin": { "type": "string", "example": "API" }, "userAgent": { "type": "string" } } }, "stats": { "type": "object", "properties": { "inputBodyLen": { "type": "integer", "example": 2000 }, "rebootCount": { "type": "integer", "example": 0 }, "restartCount": { "type": "integer", "example": 0 }, "resurrectCount": { "type": "integer", "example": 0 }, "computeUnits": { "type": "integer", "example": 0 } } }, "options": { "type": "object", "properties": { "build": { "type": "string", "example": "latest" }, "timeoutSecs": { "type": "integer", "example": 300 }, "memoryMbytes": { "type": "integer", "example": 1024 }, "diskMbytes": { "type": "integer", "example": 2048 } } }, "buildId": { "type": "string" }, "defaultKeyValueStoreId": { "type": "string" }, "defaultDatasetId": { "type": "string" }, "defaultRequestQueueId": { "type": "string" }, "buildNumber": { "type": "string", "example": "1.0.0" }, "containerUrl": { "type": "string" }, "usage": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "integer", "example": 1 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } }, "usageTotalUsd": { "type": "number", "example": 0.00005 }, "usageUsd": { "type": "object", "properties": { "ACTOR_COMPUTE_UNITS": { "type": "integer", "example": 0 }, "DATASET_READS": { "type": "integer", "example": 0 }, "DATASET_WRITES": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_READS": { "type": "integer", "example": 0 }, "KEY_VALUE_STORE_WRITES": { "type": "number", "example": 0.00005 }, "KEY_VALUE_STORE_LISTS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_READS": { "type": "integer", "example": 0 }, "REQUEST_QUEUE_WRITES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_INTERNAL_GBYTES": { "type": "integer", "example": 0 }, "DATA_TRANSFER_EXTERNAL_GBYTES": { "type": "integer", "example": 0 }, "PROXY_RESIDENTIAL_TRANSFER_GBYTES": { "type": "integer", "example": 0 }, "PROXY_SERPS": { "type": "integer", "example": 0 } } } } } } } } } }