{ "openapi": "3.0.1", "info": { "title": "Xiaohongshu (RedNote) AI Transcript API – Video to Text", "description": "Transcribe public Xiaohongshu (RedNote) videos with AI. Get clean text, timestamped segments, SRT and WebVTT subtitles, with optional translation, metadata, and downloadable video URLs.", "version": "1.0", "x-build-id": "X8SZj61dj9adL8AZF" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/lance_api~rednote-video-ai-transcript-scraper-api/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-lance_api-rednote-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~rednote-video-ai-transcript-scraper-api/runs": { "post": { "operationId": "runs-sync-lance_api-rednote-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~rednote-video-ai-transcript-scraper-api/run-sync": { "post": { "operationId": "run-sync-lance_api-rednote-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": "Note IDs, links, or share text", "minItems": 1, "maxItems": 1000, "type": "array", "description": "Add 1–1000 notes. A 24-character hexadecimal note ID is preferred. Find it after /explore/, /discovery/item/, or /red_video/ in a Xiaohongshu URL, or in the noteId/id field of a search or user-notes result. Full xiaohongshu.com links, xhslink.com/xhslink.cn short links, and complete app share text are also supported.", "items": { "type": "string" } }, "xsecToken": { "title": "Xsec token (optional)", "type": "string", "description": "Optional xsec_token for the same public note. You can submit a note ID or URL without one, keep a token in its original URL, or provide it here. When both are present, this field takes priority. For a batch with different tokens, keep each token in its matching URL. Missing tokens are allowed; invalid or expired tokens may prevent the note from resolving." }, "formats": { "title": "Transcript formats", "uniqueItems": true, "type": "array", "description": "Choose plain text for LLM workflows, segments for timestamped analysis, or SRT/VTT for subtitle files.", "items": { "type": "string", "enum": [ "text", "segments", "srt", "vtt" ], "enumTitles": [ "Plain text", "Timestamped segments", "SRT subtitles", "WebVTT subtitles" ] }, "default": [ "text", "segments" ] }, "includeMediaMetadata": { "title": "Include note metadata", "type": "boolean", "description": "Turn this off when you only need the transcript. Transcript quality stays the same while the JSON stays smaller.", "default": true }, "includeVideoUrl": { "title": "Return downloadable video URL", "type": "boolean", "description": "Optional paid add-on. Enable this only when you also need a downloadable video URL in the output. It may require a separate video-detail lookup and charges one additional video URL result fee. Transcription still works when this is off.", "default": false }, "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; no language code knowledge is required.", "default": "en" }, "webSession": { "title": "Optional web session", "type": "string", "description": "Optional session value you are authorized to use when a public note does not load normally. Most users should leave this empty." } } }, "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 } } } } } } } } } }