API reference · Xiaohongshu

xiaohongshu/pgy-v2/data-core-data

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

APISynchronousOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/api/xiaohongshu/pgy-v2/data-core-data

Model IDxiaohongshu/pgy-v2/data-core-data

Input Schema

5 parameters · 1 required · 4 optional

Parameter	Type	Required	Description
`userId`	string	Required	KOL's user ID.
`business`	string	Optional	Business type. · Options: DAILY_NOTE, COOPERATE_NOTE · Default: "DAILY_NOTE" DAILY_NOTECOOPERATE_NOTE
`dateType`	string	Optional	Time range for data. · Options: DAY_30, DAY_90 · Default: "DAY_30" DAY_30DAY_90
`noteType`	string	Optional	Type of note. · Options: PHOTO_TEXT_AND_VIDEO, PHOTO_TEXT, VIDEO · Default: "PHOTO_TEXT_AND_VIDEO" PHOTO_TEXT_AND_VIDEOPHOTO_TEXTVIDEO
`advertiseSwitch`	string	Optional	Advertisement filter. · Options: ALL, ORGANIC_ONLY · Default: "ALL" ALLORGANIC_ONLY

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Code Examples

Ready-to-run snippets

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/api/xiaohongshu/pgy-v2/data-core-data", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "userId": "5a73c5fa4eacab4c4ccc9778",
    "business": "DAILY_NOTE",
    "dateType": "DAY_30",
    "noteType": "PHOTO_TEXT_AND_VIDEO",
    "advertiseSwitch": "ALL"
  }),
});

if (!response.ok) throw new Error(await response.text());
console.log(await response.json());

← Back to Xiaohongshu Pugongying Creator Core Metrics