{ "openapi": "3.0.1", "info": { "title": "YouTube Question Backlog & FAQ Brief", "description": "Turn imported YouTube comments into a ranked question queue and recurring FAQ topics, with exact source evidence and creator-reply coverage. Import JSON or an existing Apify dataset. Export a readable HTML brief, CSV and JSON.", "version": "0.0", "x-build-id": "aRZWBFs828tezhGUQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/symmetrical_omelet_yit~youtube-question-backlog/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-symmetrical_omelet_yit-youtube-question-backlog", "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/symmetrical_omelet_yit~youtube-question-backlog/runs": { "post": { "operationId": "runs-sync-symmetrical_omelet_yit-youtube-question-backlog", "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/symmetrical_omelet_yit~youtube-question-backlog/run-sync": { "post": { "operationId": "run-sync-symmetrical_omelet_yit-youtube-question-backlog", "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": { "demoMode": { "title": "✨ Explore the sample FAQ brief", "type": "boolean", "description": "Fixed synthetic examples of recurring questions and different reply-coverage states. Turn off before supplying your own source. No network collection or API key.", "default": false }, "sourceDatasetId": { "title": "🗂️ Choose a comment dataset", "type": "string", "description": "Optional existing Apify dataset containing YouTube comment objects. Reads at most maxComments records in insertion order. Use this OR pasted comments; leave blank for the sample. Read-only access is requested only for the selected dataset." }, "comments": { "title": "📋 Or paste comment JSON", "maxItems": 1000, "type": "array", "description": "Array of comment objects. Minimum: text. Recommended: id, videoId, likes, authorChannelId, replyCount, replies and repliesComplete. Common comment/commentText/question and cid/commentId aliases and YouTube API thread objects are accepted. See README examples. No URL scraping is performed.", "default": [] }, "creatorChannelIds": { "title": "🎬 Creator channel IDs", "maxItems": 20, "type": "array", "description": "Stable YouTube channel IDs beginning UC (24 characters), not handles or channel URLs. Up to 20. For multiple channels, use only the creator IDs relevant to your imported videos.", "items": { "type": "string", "pattern": "^UC[A-Za-z0-9_-]{22}$" }, "default": [] }, "reportName": { "title": "🏷️ Brief name", "minLength": 1, "maxLength": 80, "type": "string", "description": "Shown at the top of your exported brief, for example October product questions.", "default": "YouTube question backlog" }, "minGroupSize": { "title": "🔁 Questions needed for a recurring topic", "minimum": 1, "maximum": 20, "type": "integer", "description": "Mark a conservatively grouped topic as recurring at this count. All question candidates remain in the reply queue. English rules and token overlap can miss or misgroup questions; review the evidence.", "default": 2 }, "maxComments": { "title": "📏 Maximum comments to import", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Dataset sample cap, up to 1,000 records and 8 MiB. A pasted array larger than this limit is rejected. Dataset samples use insertion order and may not represent the full audience.", "default": 1000 } } }, "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 } } } } } } } } } }