{ "openapi": "3.0.1", "info": { "title": "China Consumer Voice & Competitor Intelligence", "description": "Analyze Chinese social and community data across RedNote, Douyin, Weibo, Zhihu, Douban, and other sources for consumer concerns, needs, alternatives, brand associations, competitor differences, and content opportunities.", "version": "0.1", "x-build-id": "EmfpunzMHzdl0XUXV" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/scrupulous_buckler~china-consumer-competitor-intelligence/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-scrupulous_buckler-china-consumer-competitor-intelligence", "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~china-consumer-competitor-intelligence/runs": { "post": { "operationId": "runs-sync-scrupulous_buckler-china-consumer-competitor-intelligence", "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~china-consumer-competitor-intelligence/run-sync": { "post": { "operationId": "run-sync-scrupulous_buckler-china-consumer-competitor-intelligence", "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": { "mode": { "title": "Report mode", "enum": [ "demo", "fullReport", "consumerVoice", "competitorAnalysis", "contentOpportunities" ], "type": "string", "description": "Run the multi-platform demo or generate one focused or full intelligence report.", "default": "demo" }, "topic": { "title": "Market, category, or consumer topic", "type": "string", "description": "For example: blood glucose management, sunscreen, infant formula, language learning, or electric vehicles." }, "uploadedRecords": { "title": "Normalized or raw records", "type": "array", "description": "Paste posts, notes, answers, articles, reviews, or comments. Common field names from RedNote, Douyin, Weibo, Zhihu, Douban, and generic scrapers are recognized.", "default": [] }, "platformDatasets": { "title": "Grouped platform or competitor datasets", "type": "array", "description": "Optional groups: [{\"platform\":\"xiaohongshu\",\"brand\":\"Brand A\",\"records\":[...]}, {\"platform\":\"zhihu\",\"comments\":[...]}].", "default": [] }, "knownEntities": { "title": "Known brands, products, ingredients, tools, and alternatives", "type": "array", "description": "Names to measure in the supplied discussions. Include the client brand, competitors, ingredients, devices, services, and non-product alternatives.", "default": [], "items": { "type": "string" } }, "competitorNames": { "title": "Competitors to compare", "type": "array", "description": "Two to ten brand or product names for competitor mode. These names are also added to known entities.", "default": [], "items": { "type": "string" } }, "regulatedTopic": { "title": "Regulated health, finance, or other sensitive topic", "type": "boolean", "description": "Adds risky-claim evidence and safer framing. This is a screening aid, not legal, medical, or regulatory approval.", "default": false }, "maxEvidence": { "title": "Maximum evidence excerpts per section", "minimum": 5, "maximum": 100, "type": "integer", "description": "Limits source-linked excerpts returned for questions, concerns, entities, and opportunities.", "default": 20 }, "maxOpportunities": { "title": "Maximum content opportunities", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of ranked evidence-backed content opportunities.", "default": 10 }, "maxRecords": { "title": "Maximum input discussions", "minimum": 1, "maximum": 5000, "type": "integer", "description": "Hard processing limit across uploaded records and grouped datasets.", "default": 5000 } } }, "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 } } } } } } } } } }