{ "openapi": "3.0.1", "info": { "title": "TikTok Intelligence & Data Scraper (MCP & AI Agent Ready)", "description": "Scrape TikTok profiles, videos, transcripts, comments, and hashtags. Extract creator leads, virality metrics, and clean data for AI agents & MCP.", "version": "1.0", "x-build-id": "l51H9vFbvIEAh5357" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/bytefoundry~tiktok-intelligence-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-bytefoundry-tiktok-intelligence-scraper", "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/bytefoundry~tiktok-intelligence-scraper/runs": { "post": { "operationId": "runs-sync-bytefoundry-tiktok-intelligence-scraper", "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/bytefoundry~tiktok-intelligence-scraper/run-sync": { "post": { "operationId": "run-sync-bytefoundry-tiktok-intelligence-scraper", "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": [ "query" ], "properties": { "query": { "title": "Query, Username, Hashtag, or URL", "type": "string", "description": "Enter any TikTok target: profile handle (@username), video URL, hashtag (#tag), or general search keywords. The smart router automatically detects the target type." }, "mode": { "title": "Extraction Mode", "enum": [ "auto", "profiles", "videos", "hashtags", "search", "comments" ], "type": "string", "description": "Select extraction mode. 'auto' automatically detects mode from the query. Explicit modes force profile, video, hashtag, search, or comment extraction.", "default": "auto" }, "maxItems": { "title": "Maximum Items", "minimum": 0, "type": "integer", "description": "Maximum number of records to extract. Set to 0 for unlimited (safely bounded by your Apify spending limit).", "default": 20 }, "sortBy": { "title": "Sort Order (Search)", "enum": [ "relevance", "most_liked", "date" ], "type": "string", "description": "Sort order for search discovery queries.", "default": "relevance" }, "extractTranscripts": { "title": "Extract Video Transcripts", "type": "boolean", "description": "Extract full closed captions, dialogue transcripts, and subtitles for videos. Highly recommended for AI agents analyzing video content.", "default": true }, "extractComments": { "title": "Extract Comments", "type": "boolean", "description": "Extract top viewer comments and discussions when scraping video posts.", "default": false }, "maxCommentsPerVideo": { "title": "Max Comments Per Video", "minimum": 0, "type": "integer", "description": "Number of top comments to retrieve per video when comment extraction is enabled.", "default": 10 }, "outputFormat": { "title": "Output Format", "enum": [ "both", "json", "markdown" ], "type": "string", "description": "Format for extracted records. 'markdown' returns high-density summaries for LLM prompt context windows, 'json' returns full structured data, 'both' returns both.", "default": "both" }, "proxyConfiguration": { "title": "Proxy Configuration", "type": "object", "description": "Proxy settings. Defaults to two-tier auto-escalation (Datacenter with automatic escalation to Residential upon anti-bot challenge).", "default": { "useApifyProxy": true } } } }, "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 } } } } } } } } } }