{ "openapi": "3.0.1", "info": { "title": "YouTube", "description": "Collect YouTube channels, videos, shorts, live streams, playlists, podcasts, community posts and comments with multiple inputs and search filters.", "version": "2.4", "x-build-id": "QJFxKgJWbYoaKr3I4" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/canadesk~youtube/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-canadesk-youtube", "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/canadesk~youtube/runs": { "post": { "operationId": "runs-sync-canadesk-youtube", "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/canadesk~youtube/run-sync": { "post": { "operationId": "run-sync-canadesk-youtube", "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": { "process": { "title": "Process", "enum": [ "gct", "gcm", "gcc", "giv", "gip", "gss" ], "type": "string", "description": "Choose a channel tab, all channel content, a video, a playlist or a search.", "default": "gct" }, "mode": { "title": "Details", "enum": [ "light", "full" ], "type": "string", "description": "Full mode enriches channel videos and playlists with available details. Light mode collects listing data.", "default": "light" }, "queries": { "title": "Multiple URLs or queries", "type": "array", "description": "Optional list of up to 100 inputs. Takes precedence over the single input.", "items": { "type": "string" } }, "query": { "title": "URL or search query", "type": "string", "description": "Single YouTube URL or search query. For multiple inputs, use the list below." }, "maximum": { "title": "Maximum results", "minimum": 1, "maximum": 9999, "type": "integer", "description": "Maximum items per search, channel tab or playlist. Available content and the run budget may limit results.", "default": 40 }, "sorting": { "title": "Sorting", "enum": [ "latest", "oldest", "popular" ], "type": "string", "description": "Sort channel tabs or the collected comments. Oldest comments sorts the fetched sample.", "default": "latest" }, "follow": { "title": "Search Filters", "enum": [ "all", "Last hour", "Today", "This week", "This month", "This year", "Video", "Channel", "Playlist", "Film", "Under 4 minutes", "4 - 20 minutes", "Over 20 minutes", "Live", "4K", "HD", "Subtitles/CC", "Creative Commons", "360°", "VR180", "3D", "HDR", "Location" ], "type": "string", "description": "Optional YouTube search filter.", "default": "all" }, "daterange": { "title": "Date filter", "type": "array", "description": "Optional [startDate, endDate] in YYYY-MM-DD form. Either bound can be empty. Relative publication labels are approximate." }, "delay": { "title": "Delay", "minimum": 0, "maximum": 30, "type": "integer", "description": "Seconds between source requests.", "default": 1 }, "retries": { "title": "Retries", "minimum": 0, "maximum": 5, "type": "integer", "description": "Maximum blocked-request retries shared across the run.", "default": 1 }, "maxComments": { "title": "Comments per video", "minimum": 0, "maximum": 9999, "type": "integer", "description": "Maximum comments for video lookups and full details. Use 0 to skip comments. If omitted, follows maximum results." }, "batch": { "title": "Detail batch size", "minimum": 1, "maximum": 30, "type": "integer", "description": "Accepted for compatibility with existing bulk inputs. Requests run sequentially.", "default": 1 }, "proxy": { "title": "Proxy configuration", "type": "object", "description": "Direct requests are supported. Choose an Apify or custom proxy if needed.", "default": { "useApifyProxy": 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 } } } } } } } } } }