API reference · Xiaohongshu

xiaohongshu/pgy/blogger-notes

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/blogger-notes

Model IDxiaohongshu/pgy/blogger-notes

Input Schema

9 parameters · 1 required · 8 optional

Parameter	Type	Required	Description
`user_id`	string	Required	Blogger user ID
`note_type`	integer	Optional	Note type, 0=all, 1=image, 2=video, 4=image+video · Options: 0, 1, 2, 4 0124
`page_size`	integer	Optional	Page size (1-100) · Min: 1 · Max: 100
`order_type`	integer	Optional	Order, 1=most read, 2=most interaction, 3=latest · Options: 1, 2, 3 123
`content_tag`	string	Optional	按内容类目筛选，如美妆；取值见博主详情的 contentTags/Filter by content tag · Max length: 64 · Default: ""
`feature_tag`	string	Optional	按内容特征筛选，如韩系；取值见博主详情的 featureTags/Filter by feature tag · Max length: 64 · Default: ""
`page_number`	integer	Optional	Page number, start from 1 · Min: 1 · Max: 1000
`advertise_switch`	integer	Optional	Traffic type, 1=all (incl. ads), 0=organic only · Options: 0, 1 01
`is_third_platform`	integer	Optional	1=只看跨域合作笔记 0=不限(默认)/Cross-platform notes only · Options: 0, 1 · Default: 0 01

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/blogger-notes", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "content_tag": "美妆",
    "feature_tag": "韩系",
    "is_third_platform": 0,
    "advertise_switch": 1,
    "note_type": 4,
    "order_type": 1,
    "page_number": 1,
    "page_size": 8,
    "user_id": "5c668b3e0000000012021605"
  }),
});

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

← Back to Xiaohongshu (RED) PGY Blogger Notes