{ "openapi": "3.0.1", "info": { "title": "TikTok Media Downloader", "description": "This powerful tool enables the seamless downloading of premium quality TikTok content. Extract videos with or without watermarks and save audio tracks separately with just a few clicks. Perfect for content creators, marketers, and researchers who need reliable TikTok media extraction.", "version": "0.0", "x-build-id": "nROJv4P29CZxnEgmX" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/web.harvester~tiktok-media-downloader/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-web.harvester-tiktok-media-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/web.harvester~tiktok-media-downloader/runs": { "post": { "operationId": "runs-sync-web.harvester-tiktok-media-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/web.harvester~tiktok-media-downloader/run-sync": { "post": { "operationId": "run-sync-web.harvester-tiktok-media-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": [ "startUrls", "downloadType", "proxyConfiguration" ], "properties": { "startUrls": { "title": "Start URLs", "type": "array", "description": "URLs to start with.", "items": { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "title": "URL of a web page", "format": "uri" } } } }, "downloadType": { "title": "Download Type", "enum": [ "video", "audio", "videoOrAudio" ], "type": "string", "description": "What will be pushed to the dataset from this actor", "default": "video" }, "noWatermarkOnly": { "title": "No-Watermark Videos Only", "type": "boolean", "description": "Whether to download only the video without watermark. If only watermarked videos are available, the video will be skipped.", "default": false }, "downloadTimeoutSecs": { "title": "Download Timeout Seconds for each URL", "type": "integer", "description": "Maximum seconds to wait for each CDN media download HTTP request. Increase for large files or slow residential proxies.", "default": 500 }, "stallTimeoutSecs": { "title": "Stall Timeout Seconds", "type": "integer", "description": "Abort and retry on a fresh proxy if no data is received for this many seconds during a download. Catches frozen connections quickly.", "default": 30 }, "slowDownloadTimeoutSecs": { "title": "Slow Download Timeout Seconds", "type": "integer", "description": "Abort a download attempt that exceeds this many seconds and retry on a fresh proxy (a faster proxy is often available). Set to 0 to disable. Lower it if some proxies download too slowly.", "default": 120 }, "verboseProgress": { "title": "Verbose Progress Logs", "type": "boolean", "description": "Enable detailed percentage progress logs for debugging. Leave disabled for cleaner production logs.", "default": false }, "skipPreviouslyDownloaded": { "title": "Skip Previously Downloaded Videos", "type": "boolean", "description": "Persist downloaded video IDs across runs and skip them on future runs. Useful for scheduled/incremental jobs. When enabled, re-running the same input downloads nothing new. Note: the same video submitted under multiple URL formats always yields a single dataset row, regardless of this setting.", "default": false }, "maxRequestRetries": { "title": "Max Request Retries", "type": "integer", "description": "Number of times to retry a request.", "default": 25 }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Residential proxies are strongly recommended: the download provider blocks datacenter IPs, which causes empty/failed downloads. Datacenter proxies use fewer credits but will frequently fail." } } }, "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 } } } } } } } } } }