{ "openapi": "3.0.1", "info": { "title": "TikTok Live Supervisor", "description": "Monitor multiple TikTok accounts 24/7. Auto-launch Comments & Recorder the moment any stream goes live. Unlimited. Cookies supported.", "version": "1.0", "x-build-id": "E1AyrpGcCnyoRPwAO" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/ben-belaouedj~tiktok-live-supervisor/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-ben-belaouedj-tiktok-live-supervisor", "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/ben-belaouedj~tiktok-live-supervisor/runs": { "post": { "operationId": "runs-sync-ben-belaouedj-tiktok-live-supervisor", "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/ben-belaouedj~tiktok-live-supervisor/run-sync": { "post": { "operationId": "run-sync-ben-belaouedj-tiktok-live-supervisor", "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": [ "users" ], "properties": { "users": { "title": "TikTok Usernames to Monitor", "type": "array", "description": "List of TikTok usernames to watch for live streams (without the @ prefix). Example: [\"charlidamelio\", \"khaby.lame\"]", "items": { "type": "string" } }, "poll_interval_seconds": { "title": "Poll Interval (seconds)", "minimum": 10, "type": "integer", "description": "How often (in seconds) to check whether any monitored creator has gone live. Lower = faster detection, higher = fewer API calls.", "default": 30 }, "apify_token": { "title": "Apify API Token", "type": "string", "description": "Your Apify API token, used to start and stop child actor runs. Can also be set via the APIFY_TOKEN environment variable." }, "comments_actor_id": { "title": "Comments Actor ID", "type": "string", "description": "Full Actor ID of the tiktok-live-comments actor (e.g. your-username/tiktok-live-comments)." }, "recorder_actor_id": { "title": "Recorder Actor ID", "type": "string", "description": "Full Actor ID of the tiktok-live-recorder actor (e.g. your-username/tiktok-live-recorder)." }, "enable_comments": { "title": "Enable Comments Collection", "type": "boolean", "description": "Automatically launch the Comments Scraper for each detected live stream.", "default": true }, "enable_recorder": { "title": "Enable Video Recording", "type": "boolean", "description": "Automatically launch the Stream Recorder for each detected live stream.", "default": true }, "max_duration_seconds": { "title": "Max Duration Per Live (seconds) — 0 = unlimited", "minimum": 0, "type": "integer", "description": "Maximum duration in seconds for each child actor run. Set to 0 for no limit — records and scrapes until the stream ends naturally.", "default": 0 }, "quality": { "title": "Video Quality (for Recorder)", "enum": [ "best", "uhd", "sd", "ld", "origin" ], "type": "string", "description": "Preferred stream quality passed to the Recorder actor. 'best' automatically picks the highest available.", "default": "best" }, "cookies": { "title": "TikTok Session Cookies (JSON array)", "type": "array", "description": "Your TikTok session cookies exported as a JSON array. Provided once here and forwarded automatically to every child Comments and Recorder run.\n\nHow to export:\n1. Install Cookie-Editor or EditThisCookie in your browser\n2. Log into TikTok\n3. Open the extension → Export → copy the JSON array\n4. Save it to a local file (e.g. cookies.json) and paste the array here\n\nKey cookies: sessionid, sid_tt, odin_tt, ttwid" } } }, "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 } } } } } } } } } }