{ "openapi": "3.0.1", "info": { "title": "Tiktok Video Downloader", "description": "Meet the TikTok Video Downloader, your simple solution for saving high-quality, watermark-free videos directly from TikTok. Pro Tip: This actor is optimized for maximum speed. For the fastest possible downloads, disable proxies and use the default Apify IP.", "version": "0.0", "x-build-id": "xi35avMUKaegaPWVw" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/shahidirfan~Tiktok-Video-Downloader/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-shahidirfan-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/shahidirfan~Tiktok-Video-Downloader/runs": { "post": { "operationId": "runs-sync-shahidirfan-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/shahidirfan~Tiktok-Video-Downloader/run-sync": { "post": { "operationId": "run-sync-shahidirfan-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": [ "searchMode" ], "properties": { "searchMode": { "title": "Search Mode", "enum": [ "url", "hashtag" ], "type": "string", "description": "Choose how to find TikTok videos.\n\n- Direct URLs: Paste TikTok video URLs.\n- Hashtag: Enter hashtag (no #).\n\nUser profile and keyword search are temporarily disabled due to TikTok changes.", "default": "url" }, "queryInput": { "title": "TikTok Search / URL Input", "type": "string", "description": "Input format depends on selected mode:\n\n- Direct URLs: Paste one or more TikTok video URLs (comma, newline, or JSON array). Short links (vm.tiktok.com) are supported.\n- Hashtag: Enter hashtag (without # symbol).\n\nUser profile and keyword search are temporarily disabled." }, "maxVideos": { "title": "Maximum Videos to Download", "minimum": 1, "maximum": 100, "type": "integer", "description": "Maximum number of videos to download from search results or user profiles. Applies to all modes.", "default": 10 }, "downloadMode": { "title": "Download Mode", "enum": [ "videos", "metadata_only" ], "type": "string", "description": "Choose whether to download full videos or extract metadata only.", "default": "videos" }, "quality": { "title": "Video Quality", "enum": [ "best", "720p", "1080p", "audio_only" ], "type": "string", "description": "Preferred video quality/format. Only applies when downloading videos. The actor automatically falls back to lower or best available qualities if the requested one is missing.", "default": "best" }, "useProxy": { "title": "Use Proxy", "type": "boolean", "description": "Whether to use proxy for downloading. Disable for faster downloads if you don't need proxy protection.", "default": true }, "maxDownloadSpeed": { "title": "Maximum Download Speed (KB/s)", "minimum": 0, "type": "integer", "description": "Limit download speed in KB/s to prevent extremely slow downloads. Set to 0 for unlimited speed.", "default": 0 }, "cookies": { "title": "TikTok Cookies (optional)", "type": "string", "description": "Optional cookies to bypass TikTok authentication. Accepts both JSON format (from browser dev tools) and Netscape format. JSON cookies will be automatically converted. Leave empty if videos are publicly accessible." }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings for downloading TikTok videos. Only used when 'Use Proxy' is enabled. Recommended to use Apify Proxy to avoid potential rate limiting or IP blocking.", "default": {} } } }, "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 } } } } } } } } } }