{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu (RedNote) Video Transcript Scraper", "description": "Turn trending Xiaohongshu (RedNote) videos into searchable text. Pick a category and get AI transcripts with timestamps, plus title, post text, hashtags, author, publish date, likes, saves, comments, shares and video details — China market research ina language you read.", "version": "0.0", "x-build-id": "J67dXs3qTQMyoNEKg" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/piotrv1001~xiaohongshu-rednote-video-transcript-scraper/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-piotrv1001-xiaohongshu-rednote-video-transcript-scraper", "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/piotrv1001~xiaohongshu-rednote-video-transcript-scraper/runs": { "post": { "operationId": "runs-sync-piotrv1001-xiaohongshu-rednote-video-transcript-scraper", "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/piotrv1001~xiaohongshu-rednote-video-transcript-scraper/run-sync": { "post": { "operationId": "run-sync-piotrv1001-xiaohongshu-rednote-video-transcript-scraper", "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": { "categories": { "title": "Categories", "uniqueItems": true, "type": "array", "description": "Categories to sample trending videos from. Each run pulls a fresh set of posts, so repeated runs keep returning new videos.", "items": { "type": "string", "enum": [ "homefeed.video_v", "homefeed_recommend", "homefeed.fashion_v", "homefeed.food_v", "homefeed.cosmetics_v", "homefeed.travel_v", "homefeed.fitness_v", "homefeed.gaming_v", "homefeed.movie_and_tv_v", "homefeed.career_v", "homefeed.love_v", "homefeed.household_product_v" ], "enumTitles": [ "Video", "Recommended", "Fashion", "Food", "Beauty & cosmetics", "Travel", "Fitness", "Gaming", "Movies & TV", "Career", "Relationships", "Home & household" ] }, "default": [] }, "postUrls": { "title": "Post URLs", "uniqueItems": true, "type": "array", "description": "Specific posts to transcribe. Copy the full URL from the site — the whole query string is required for the post to open.", "default": [], "items": { "type": "string" } }, "onlyVideosWithSpeech": { "title": "Only videos with speech", "type": "boolean", "description": "About half the videos on this platform are music over footage with nobody talking, and there is nothing to transcribe in those. Leave this on to get only videos that actually contain speech. Turn it off to have them returned too, as post records without a transcript.", "default": true }, "maxResults": { "title": "Max results", "minimum": 1, "maximum": 1000, "type": "integer", "description": "Hard cap on the number of video posts returned across the whole run.", "default": 20 }, "maxVideoMinutes": { "title": "Max video length (minutes)", "minimum": 1, "maximum": 180, "type": "integer", "description": "Videos longer than this are returned with their post data but no transcript, and are not charged for transcription. A small number of posts here are hours-long livestream replays, so this keeps a run's cost predictable.", "default": 20 }, "language": { "title": "Spoken language", "enum": [ "zh", "auto", "en", "ja", "ko", "es", "pt", "fr", "de", "it", "ru", "id", "th", "vi" ], "type": "string", "description": "Language of the audio. Most posts on this platform are in Mandarin, which is the default. Automatic detection also works but is slower.", "default": "zh" }, "proxyConfiguration": { "title": "Proxy configuration", "type": "object", "description": "Proxy settings. A proxy is required — the source limits how much any single address may request.", "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 } } }, "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 } } } } } } } } } }