{ "openapi": "3.0.1", "info": { "title": "TikTok Video Downloader & Metadata API", "description": "Download public TikTok videos as MP4 files stored in Apify. Process up to 50 links per run and extract authors, views, likes, comments and video metadata. Get saved file URLs and structured JSON for archives, analytics and automated workflows.", "version": "1.5", "x-build-id": "jkueFeIbyVHLwo8tC" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/alex_fodo~tiktok-scraper-no-watermark/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-alex_fodo-tiktok-scraper-no-watermark", "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/alex_fodo~tiktok-scraper-no-watermark/runs": { "post": { "operationId": "runs-sync-alex_fodo-tiktok-scraper-no-watermark", "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/alex_fodo~tiktok-scraper-no-watermark/run-sync": { "post": { "operationId": "run-sync-alex_fodo-tiktok-scraper-no-watermark", "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": [ "urls" ], "properties": { "urls": { "title": "TikTok Video URLs", "minItems": 1, "maxItems": 50, "type": "array", "description": "1–50 HTTPS TikTok video or short links. Other platforms, profiles and photo posts are unsupported.", "items": { "type": "string" } }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Optional Apify/custom proxy. Different sessions are used per item; access is not guaranteed.", "default": { "useApifyProxy": false } }, "socketTimeoutSecs": { "title": "Network timeout (seconds)", "minimum": 5, "maximum": 60, "type": "integer", "description": "Per network operation timeout, not a total per-video deadline.", "default": 15 }, "retries": { "title": "Retries", "minimum": 0, "maximum": 2, "type": "integer", "description": "Maximum network and extraction retry counts.", "default": 1 }, "downloadVideo": { "title": "Save MP4 in Apify", "type": "boolean", "description": "Save a bounded MP4 with metadata. False returns metadata and a temporary TikTok URL.", "default": true }, "maxVideoSizeMb": { "title": "Maximum video size (MiB)", "minimum": 1, "maximum": 50, "type": "integer", "description": "Larger videos return VIDEO_TOO_LARGE without a result fee.", "default": 25 }, "requireUnmarkedFormat": { "title": "Require an explicitly unmarked format", "type": "boolean", "description": "Always skip formats flagged with a watermark. True also rejects unknown watermark metadata with WATERMARK_NOT_CONFIRMED and no result fee. This uses extractor metadata, not visual watermark detection.", "default": false }, "requestIntervalSecs": { "title": "Pause between videos (seconds)", "minimum": 1, "maximum": 30, "type": "integer", "description": "Minimum pause after each attempted video. Extraction also uses a 1-second pause between supported metadata requests. No guaranteed TikTok-safe rate.", "default": 3 }, "maxRunSecs": { "title": "Processing time limit (seconds)", "minimum": 30, "maximum": 3600, "type": "integer", "description": "Soft limit: stop starting videos after this time. An in-flight operation may exceed it; set the platform timeout higher.", "default": 600 }, "maxTotalVideoSizeMb": { "title": "Total downloaded size limit (MiB)", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Bounds successful downloaded payloads in one run; excludes metadata, probes, failed transfers and platform overhead. Remaining URLs are returned in OUTPUT.", "default": 250 } } }, "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 }, "PROXY_UNBLOCKER_UNITS": { "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 }, "PROXY_UNBLOCKER_UNITS": { "type": "integer", "example": 0 } } } } } } } } } }