API reference · Xiaohongshu
xiaohongshu/pgy-v2/data-v2-notes-detail
Integrate this model through SandBase's unified API, with production-ready schemas and examples.
Production endpoint
Send your first request
OpenAI-compatible endpoint with unified authentication and usage tracking.
POST
https://api.sandbase.ai/v1/api/xiaohongshu/pgy-v2/data-v2-notes-detailModel ID
xiaohongshu/pgy-v2/data-v2-notes-detail01
Input Schema
6 parameters · 1 required · 5 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
userId | string | Required | KOL's user ID. |
noteType | string | Optional | Type of note. · Options: ALL, COOPERATION, PHOTO_TEXT, VIDEO · Default: "ALL" ALLCOOPERATIONPHOTO_TEXTVIDEO |
orderType | string | Optional | Sorting order. · Options: LATEST, MOST_READ, MOST_INTERACT · Default: "LATEST" LATESTMOST_READMOST_INTERACT |
pageNumber | integer | Optional | Page number. · Default: 1 |
advertiseSwitch | string | Optional | Advertisement filter. · Options: ALL, ORGANIC_ONLY · Default: "ALL" ALLORGANIC_ONLY |
isThirdPlatform | string | Optional | Whether from third-party platform. · Options: NO, YES · Default: "NO" NOYES |
02
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 |
03
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-v2-notes-detail", {
method: "POST",
headers: {
Authorization: `Bearer ${apiKey}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"userId": "64b898310000000014037b21",
"noteType": "ALL",
"orderType": "LATEST",
"pageNumber": 1,
"advertiseSwitch": "ALL",
"isThirdPlatform": "NO"
}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());