{
  "openapi": "3.0.1",
  "info": {
    "title": "RedNote Comment Scraper & Consumer Insights",
    "description": "Scrape up to 100 RedNote/Xiaohongshu comments from a note URL. Get buyer questions, objections, competitor mentions, evidence quotes, sentiment, and content ideas. No Cookie. Live URL mode uses a public collector and compatible Apify plan. Maximum standard cost $1.74; no report fee on empty runs.",
    "version": "0.2",
    "x-build-id": "5KCxei0pBdB8uqapN"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/scrupulous_buckler~xiaohongshu-comment-keyword-consumer-voice/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-scrupulous_buckler-xiaohongshu-comment-keyword-consumer-voice",
        "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/scrupulous_buckler~xiaohongshu-comment-keyword-consumer-voice/runs": {
      "post": {
        "operationId": "runs-sync-scrupulous_buckler-xiaohongshu-comment-keyword-consumer-voice",
        "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/scrupulous_buckler~xiaohongshu-comment-keyword-consumer-voice/run-sync": {
      "post": {
        "operationId": "run-sync-scrupulous_buckler-xiaohongshu-comment-keyword-consumer-voice",
        "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": [
          "source"
        ],
        "properties": {
          "source": {
            "title": "Xiaohongshu / RedNote note URL",
            "type": "string",
            "description": "Accepts a full note URL, xhslink share URL, or 24-character note ID. Replace the prefilled public note with the thread you want to research."
          },
          "researchGoal": {
            "title": "What decision should the report support?",
            "enum": [
              "full-consumer-insights",
              "customer-objections",
              "purchase-questions",
              "competitor-comparisons",
              "content-ideas"
            ],
            "type": "string",
            "description": "The full report always contains all available sections. This choice labels the primary decision so the result is easier to reuse and share.",
            "default": "full-consumer-insights"
          },
          "topic": {
            "title": "Topic or product label",
            "type": "string",
            "description": "Optional label used in the report, such as sunscreen, glucose-support supplement, or Product A."
          },
          "commentKeywords": {
            "title": "Questions or terms to measure",
            "type": "array",
            "description": "Optional exact terms such as price, side effects, ingredients, taste, refund, or a campaign phrase.",
            "items": {
              "type": "string"
            }
          },
          "knownEntities": {
            "title": "Brands, products, ingredients, or alternatives",
            "type": "array",
            "description": "Optional exact names to count. The Actor does not claim to discover every brand automatically.",
            "items": {
              "type": "string"
            }
          },
          "competitorNames": {
            "title": "Competitors to compare",
            "type": "array",
            "description": "Optional competitor brand or product names. Exact matches are linked back to source comments.",
            "items": {
              "type": "string"
            }
          },
          "uploadedComments": {
            "title": "Existing comment records",
            "type": "array",
            "description": "To skip collection, set source to uploaded and paste comment JSON here. Common text, content, comment, ID, note, author, like, timestamp, and nested reply fields are recognized.",
            "default": []
          },
          "datasetId": {
            "title": "Apify comments Dataset",
            "type": "string",
            "description": "To analyze an existing Dataset, set source to dataset:DATASET_ID. The selected Dataset needs comment-like text fields."
          },
          "sourceDatasetIds": {
            "title": "Additional Apify comment Datasets",
            "maxItems": 10,
            "type": "array",
            "description": "Optional extra private or accessible Dataset IDs. At most ten Datasets and 100 total comments are analyzed."
          },
          "query": {
            "title": "Cookie-based keyword search",
            "type": "string",
            "description": "Advanced: set source to keyword:SEARCH_TERM and provide your own valid Cookie below to use the Actor's direct keyword collector."
          },
          "cookie": {
            "title": "Xiaohongshu Cookie for keyword search only",
            "type": "string",
            "description": "Not needed for the default note-URL path. Used only for direct keyword collection. It is secret and is never written to output or logs."
          },
          "includeReplies": {
            "title": "Include reply threads",
            "type": "boolean",
            "description": "Include nested replies as well as top-level comments when they are available.",
            "default": true
          },
          "maxTotalComments": {
            "title": "Comments to analyze",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "Maximum normalized comments and replies in the $0.99 analysis report.",
            "default": 100
          },
          "maxCommentsPerNote": {
            "title": "Top-level comments requested per note",
            "minimum": 1,
            "maximum": 100,
            "type": "integer",
            "description": "The upstream collector can return fewer comments when the note is small or the $0.75 upstream cap is reached.",
            "default": 100
          },
          "upstreamMaxChargeUsd": {
            "title": "Maximum separate upstream charge (USD)",
            "minimum": 0.05,
            "maximum": 1.5,
            "type": "number",
            "description": "Safety cap for zen-studio/rednote-comments-scraper. This is separate from our $0.99 report event. Default total Actor-event maximum: $0.99 + $0.75 = $1.74.",
            "default": 0.75
          },
          "requireKeywordMatch": {
            "title": "Keep only comments matching supplied terms",
            "type": "boolean",
            "description": "Off by default so surrounding consumer context is preserved.",
            "default": false
          },
          "regulatedTopic": {
            "title": "Health or other regulated topic",
            "type": "boolean",
            "description": "Adds risky-claim evidence and safer framing. This is a screening aid, not legal or medical approval.",
            "default": false
          },
          "includeSourceComments": {
            "title": "Embed normalized comments in the report row",
            "type": "boolean",
            "description": "Comment-analysis rows are always delivered separately. Turn this on only when the aggregate report should repeat them.",
            "default": false
          },
          "maxEvidence": {
            "title": "Evidence excerpts per report section",
            "minimum": 5,
            "maximum": 100,
            "type": "integer",
            "description": "Limits source-linked questions, concerns, comparisons, and supporting comments in each report section.",
            "default": 20
          },
          "maxOpportunities": {
            "title": "Ranked content opportunities",
            "minimum": 1,
            "maximum": 30,
            "type": "integer",
            "description": "Maximum evidence-backed content directions returned in the aggregate report.",
            "default": 10
          },
          "requestDelayMs": {
            "title": "Direct Cookie collector delay (ms)",
            "minimum": 500,
            "maximum": 10000,
            "type": "integer",
            "description": "Used only for the advanced direct Cookie collector, not the default cookieless upstream path.",
            "default": 1000
          },
          "proxyConfiguration": {
            "title": "Proxy for direct Cookie collection",
            "type": "object",
            "description": "Used only by the advanced direct Cookie collector.",
            "default": {
              "useApifyProxy": false
            }
          }
        }
      },
      "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
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}