{ "openapi": "3.0.1", "info": { "title": "RedNote Transcript & Subtitle API – Xiaohongshu Video to Text", "description": "Extract native subtitles and convert public RedNote (Xiaohongshu/XHS) videos to text, with AI transcription used only when needed. Get timestamped segments, SRT/VTT, optional translation, video URLs, and note metadata. A matching xsec_token is required.", "version": "1.0", "x-build-id": "07CMFYDbfg3gPAU6h" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lance_api~xiaohongshu-video-ai-transcript-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lance_api-xiaohongshu-video-ai-transcript-scraper-api", "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/lance_api~xiaohongshu-video-ai-transcript-scraper-api/runs": { "post": { "operationId": "runs-sync-lance_api-xiaohongshu-video-ai-transcript-scraper-api", "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/lance_api~xiaohongshu-video-ai-transcript-scraper-api/run-sync": { "post": { "operationId": "run-sync-lance_api-xiaohongshu-video-ai-transcript-scraper-api", "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", "required": [ "urls" ], "properties": { "urls": { "title": "RedNote video URLs with xsec_token", "minItems": 1, "maxItems": 1000, "type": "array", "description": "Add 1–1000 full Xiaohongshu video-note URLs. Each URL must contain a valid xsec_token query parameter. Open a public video note from Xiaohongshu search, feed, or sharing, then copy the complete browser URL; xsec_token appears after ? or & in that URL. A valid token makes direct media resolution more reliable. Note IDs and token-free URLs are not accepted by this Actor.", "items": { "type": "string", "pattern": "^https?://(?:www\\.)?xiaohongshu\\.com/(?:explore|red_video|discovery/item)/[0-9a-fA-F]{24}(?:/)?\\?[^#\\s]*xsec_token=[^&#\\s]+" }, "default": [ "https://www.xiaohongshu.com/explore/6a75b0f0000000003303608a?xsec_token=ABLy6_xYG1gyFlArGAB2K1M3EZNPtj3hsXL-LCiWd1Rjs=&xsec_source=pc_search&source=web_explore_feed" ] }, "formats": { "title": "Transcript formats", "uniqueItems": true, "type": "array", "description": "Choose plain text for LLM workflows, segments for timestamped analysis, or SRT/VTT for subtitles.", "items": { "type": "string", "enum": [ "text", "segments", "srt", "vtt" ], "enumTitles": [ "Plain text", "Timestamped segments", "SRT subtitles", "WebVTT subtitles" ] }, "default": [ "text", "segments" ] }, "allowAiTranscript": { "title": "Use AI transcription when needed", "type": "boolean", "description": "Use AI speech recognition only when the video does not provide a usable native subtitle. Native subtitles are always preferred because they are faster and do not require AI transcription.", "default": true }, "translate": { "title": "Translate transcript", "type": "boolean", "description": "Keep the original transcript and optionally add a translated copy.", "default": false }, "targetLanguage": { "title": "Translation language", "enum": [ "en", "zh-CN", "zh-TW", "ja", "ko", "es", "fr", "de", "pt", "it", "nl", "ru", "uk", "pl", "cs", "sv", "da", "fi", "no", "tr", "ar", "he", "hi", "bn", "id", "ms", "th", "vi", "fil", "el", "ro", "hu" ], "type": "string", "description": "Choose the target language. Start typing a language name to filter the list.", "default": "en" } } }, "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 } } } } } } } } } }