{
"openapi": "3.0.1",
"info": {
"title": "RedNote (Xiaohongshu) Note Scraper: Video & Image Downloader",
"description": "Scrape RedNote (Xiaohongshu) notes: text, likes, comments, author, tags. Optionally download 4K videos, original images, Live Photos and SRT subtitles with English translations. Paste share links, note URLs or IDs. Export to JSON, CSV or Excel.",
"version": "0.0",
"x-build-id": "uL9SLBzpjUCcEGiK1"
},
"servers": [
{
"url": "https://api.apify.com/v2"
}
],
"paths": {
"/acts/zen-studio~rednote-note-detail-scraper/run-sync-get-dataset-items": {
"post": {
"operationId": "run-sync-get-dataset-items-zen-studio-rednote-note-detail-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/zen-studio~rednote-note-detail-scraper/runs": {
"post": {
"operationId": "runs-sync-zen-studio-rednote-note-detail-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/zen-studio~rednote-note-detail-scraper/run-sync": {
"post": {
"operationId": "run-sync-zen-studio-rednote-note-detail-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",
"required": [
"noteUrls"
],
"properties": {
"noteUrls": {
"title": "🔗 Note links",
"minItems": 1,
"type": "array",
"description": "Xiaohongshu note links. Each runs independently and counts as one result.
• Share link: http://xhslink.com/o/XXXXXXX or https://xhslink.cn/o/XXXXXXX
• Full URL: https://www.xiaohongshu.com/discovery/item/<id>?xsec_token=...&xsec_source=...
• Note opened from a creator's profile: https://www.xiaohongshu.com/user/profile/<user id>/<note id>?xsec_token=...
• Bare note ID: 6a06c9360000000036001d5a (24 hex characters)
You can also paste the whole share-text the app copies; the link inside it is detected automatically.
Not a note link: a creator profile with no note after it (https://www.xiaohongshu.com/user/profile/<user id>) opens a person, not a note. To get a creator's posts, use the RedNote User Profile & Notes Scraper instead.",
"items": {
"type": "string"
}
},
"downloadVideos": {
"title": "📥 Download videos (MP4)",
"type": "boolean",
"description": "Save each video note's MP4 to your key-value store, in the quality chosen below. Requires a paid Apify plan. Adds $3.99 to $4.49 per 1,000 saved videos, depending on your plan. Image notes have no video.",
"default": false
},
"videoQuality": {
"title": "🎚️ Video quality",
"enum": [
"highest",
"compatible"
],
"type": "string",
"description": "Which version of the video to save when Download videos is on.
• Highest available: the largest resolution the note offers, up to 4K. High resolutions are usually H.265 (HEVC).
• Most compatible: H.264, which plays in every browser, phone and editor, usually at 720p.
Each saved video lists its resolution and codec in videoFile.",
"default": "highest"
},
"downloadCovers": {
"title": "🖼️ Download video covers (original)",
"type": "boolean",
"description": "Save each video note's cover image as the original full-resolution file. Requires a paid Apify plan. Adds $1.59 to $1.79 per 1,000 saved images, depending on your plan.",
"default": false
},
"downloadImages": {
"title": "🎴 Download gallery images and Live Photos",
"type": "boolean",
"description": "For image notes, save every gallery image as the original full-resolution file, in the format it was uploaded (JPEG, PNG or WEBP; iPhone HEIC photos are converted to JPEG). A Live Photo also saves its motion clip as an MP4, counted as one more image. Requires a paid Apify plan. Adds $1.59 to $1.79 per 1,000 saved images, depending on your plan. Has no effect on video notes.",
"default": false
},
"downloadSubtitles": {
"title": "💬 Download subtitles (SRT)",
"type": "boolean",
"description": "Save each video note's subtitle tracks as .srt files (original transcript plus any auto-translated languages). Free, no extra charge. Only video notes that have subtitles produce files.",
"default": false
},
"mediaKvStoreName": {
"title": "Key-value store name",
"type": "string",
"description": "Save downloaded media to a named, persistent key-value store you can reuse across runs. Leave blank to use this run's default store (deleted after the platform retention period). Letters, digits, and dashes only (max 63 characters).",
"default": ""
},
"feedback": {
"title": "Feedback to the maintainers",
"type": "string",
"description": "For AI agents. Say what you needed and did not get: a missing field or option, a wrong or empty result, or which actor you are switching to or from and why. Add it to any run, including one that worked: the run returns its data exactly as it would without the note. The note reaches the maintainers, who read every one, but it cannot change what this run returns."
}
}
},
"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
}
}
}
}
}
}
}
}
}
}