{ "openapi": "3.0.1", "info": { "title": "Kick Downloader: Stream Archive for Clips & VODs as MP4 Files", "description": "Kick downloader that builds your Kick stream archive: save clips and VODs as MP4 by channel or link, choose VOD quality from 1080p to 360p, cap file size, and let Watchlist mode catch new clips before the source VOD is deleted. Direct links, no login or API key needed.", "version": "0.2", "x-build-id": "JNUg5vucvbkzxM7yS" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/getascraper~kick-video-downloader/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-getascraper-kick-video-downloader", "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/getascraper~kick-video-downloader/runs": { "post": { "operationId": "runs-sync-getascraper-kick-video-downloader", "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/getascraper~kick-video-downloader/run-sync": { "post": { "operationId": "run-sync-getascraper-kick-video-downloader", "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": { "mode": { "title": "Mode", "enum": [ "channelClips", "channelVods", "directUrls" ], "type": "string", "description": "What to download: the latest clips from a channel, the latest VODs from a channel, or specific clip/VOD URLs you already know.", "default": "channelClips" }, "directUrls": { "title": "Clip or VOD URLs", "type": "array", "description": "Specific Kick clip or VOD page URLs to download. Used when Mode is set to specific URLs, or when no channel is set.", "default": [], "items": { "type": "string" } }, "channel": { "title": "Channel", "type": "string", "description": "Kick channel slug, from kick.com/. A full channel link or @name also works. Used when Mode is set to a channel-based option.", "default": "xqc" }, "maxItems": { "title": "Max items", "minimum": 1, "maximum": 100, "type": "integer", "description": "Stop after downloading this many clips or VODs in this run. Free-plan runs are capped at 10.", "default": 5 }, "quality": { "title": "VOD quality", "enum": [ "best", "1080p", "720p", "480p", "360p", "160p" ], "type": "string", "description": "The highest VOD quality to download. A lower quality means a smaller file, a faster run and room for longer VODs at the same memory. If the exact quality is not offered, the closest one below it is used. Clips are saved in the quality Kick provides.", "default": "best" }, "maxVodDurationMinutes": { "title": "Max VOD length to download", "minimum": 1, "maximum": 600, "type": "integer", "description": "Caps how much of a VOD is downloaded, so one long broadcast can't blow past the run's expected time, memory or cost. Does not apply to clips, which are already short. A longer VOD needs more of the run's memory - if you raise this, also raise the Actor's run memory (Run options > Memory) or choose a lower quality; the Actor stops early with a clear message telling you what to change instead of crashing.", "default": 3 }, "maxFileSizeMb": { "title": "Max file size", "minimum": 1, "maximum": 20480, "type": "integer", "description": "Skip any clip or VOD that would be larger than this. Skipped files are not charged and show the reason in the error field. Leave empty for no limit." }, "monitorMode": { "title": "Watchlist mode", "type": "boolean", "description": "Remember what was already downloaded for this channel and fetch only clips or VODs new since the last run. Turn this on for scheduled runs that need to catch a clip before its source VOD is deleted.", "default": false }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Datacenter proxy is enough for Kick's public data and is the default. Only switch to residential if you hit unexpected blocks at very high volume.", "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 } } } } } } } } } }