{ "openapi": "3.0.1", "info": { "title": "YouTube Comments Scraper: Replies, Filters & AI Summary", "description": "YouTube comments and replies for any video, Short, playlist, channel or search: text, author, likes, replies, pinned and creator-hearted flags, dates. Top or newest, filters, only-new alerts and an AI summary of what viewers say.", "version": "0.1", "x-build-id": "RanqpVZ5gGI1aTVGz" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/tacps126~youtube-comments/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-tacps126-youtube-comments", "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/tacps126~youtube-comments/runs": { "post": { "operationId": "runs-sync-tacps126-youtube-comments", "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/tacps126~youtube-comments/run-sync": { "post": { "operationId": "run-sync-tacps126-youtube-comments", "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", "properties": { "videos": { "title": "Videos, playlists or channels", "type": "array", "description": "YouTube video, Shorts, playlist or channel links (or video ids). Channels and playlists give their latest videos.", "items": { "type": "string" } }, "searchQueries": { "title": "Search queries", "type": "array", "description": "YouTube searches; the top videos of each are read.", "items": { "type": "string" } }, "maxVideosPerSource": { "title": "Videos per playlist, channel or search", "minimum": 1, "maximum": 500, "type": "integer", "description": "How many videos each playlist, channel or search adds.", "default": 10 }, "maxCommentsPerVideo": { "title": "Comments per video", "minimum": 1, "type": "integer", "description": "Top-level comments kept per video (replies come on top).", "default": 100 }, "sortBy": { "title": "Sort", "enum": [ "top", "newest" ], "type": "string", "description": "Newest first is best for monitoring.", "default": "top" }, "includeReplies": { "title": "Include replies", "type": "boolean", "description": "Also return the replies to each comment kept.", "default": false }, "maxRepliesPerComment": { "title": "Replies per comment", "minimum": 1, "type": "integer", "description": "Most replies kept per comment.", "default": 20 }, "minLikes": { "title": "Min likes", "minimum": 0, "type": "integer", "description": "Only comments with at least this many likes." }, "keywords": { "title": "Keywords", "type": "array", "description": "Only comments containing one of these words, e.g. your brand or product.", "items": { "type": "string" } }, "excludeKeywords": { "title": "Exclude keywords", "type": "array", "description": "Leave out comments containing any of these.", "items": { "type": "string" } }, "postedWithinDays": { "title": "Posted within N days", "minimum": 1, "type": "integer", "description": "Only comments from the last N days (YouTube shows relative times, so dates are estimates)." }, "maxItems": { "title": "Max comments in total", "minimum": 1, "type": "integer", "description": "Most comments returned per run.", "default": 1000 }, "onlyNew": { "title": "Only new comments", "type": "boolean", "description": "Schedule the Actor (with Newest first) and each run returns only comments earlier runs did not deliver: alerts for your videos, brand or competitors.", "default": false }, "monitorName": { "title": "Monitor name", "type": "string", "description": "Optional name for the \"only new\" history, so several monitors can run side by side." }, "tenantId": { "title": "Tenant ID", "type": "string", "description": "Optional label used to keep separate histories for different clients or teams." }, "proxyConfiguration": { "title": "Proxy", "type": "object", "description": "Not needed in most runs; videos refused without a proxy are retried through one automatically.", "default": { "useApifyProxy": false } }, "aiSummary": { "title": "AI summary per video", "type": "boolean", "description": "Add one summary row per video: overall sentiment, themes, questions, complaints, praise and follow-up video ideas from the comments read.", "default": false }, "aiProfile": { "title": "Your profile (for the fit score)", "type": "string", "description": "Who you are, e.g. \"Skincare brand watching review videos of our serum\". Adds a fit score." }, "aiLanguage": { "title": "Insight language", "type": "string", "description": "Insights are written in this language, whatever the source language.", "default": "English" }, "aiProvider": { "title": "AI provider", "enum": [ "apify", "anthropic", "openai", "gemini", "openrouter", "groq", "mistral", "deepseek", "compatible" ], "type": "string", "description": "Which AI does the analysis. Apify needs no key: the model's tokens are billed to your Apify account by Apify's AI gateway (a fraction of a cent per call with the default model). Any other provider uses your own key and bills you there.", "default": "apify" }, "aiApiKey": { "title": "AI API key", "type": "string", "description": "Your own key for the provider above (not needed for Apify). Sent only to that provider, never stored." }, "aiModel": { "title": "AI model", "type": "string", "description": "Model name. Apify: an OpenRouter id like anthropic/claude-sonnet-... or google/gemini-... (default: the newest Claude Haiku listed, a light model since it runs once per result). Anthropic: default claude-opus-5-5. Others: required." }, "aiBaseUrl": { "title": "API base URL", "type": "string", "description": "Only for \"Other OpenAI-compatible API\", e.g. http://localhost:11434/v1 for Ollama." }, "debug": { "title": "Debug", "type": "boolean", "description": "Save extra diagnostics with the run (for support requests).", "default": false } } }, "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 } } } } } } } } } }