API reference · Xiaohongshu
xiaohongshu/pgy-v2/content-square-search-note-v2
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/content-square-search-note-v2Model ID
xiaohongshu/pgy-v2/content-square-search-note-v201
Input Schema
5 parameters · 0 required · 5 optional
| Parameter | Type | Required | Description |
|---|---|---|---|
nd | string | Optional | Time range in days. · Options: DAY_3, DAY_7, DAY_14, DAY_30 · Default: "DAY_7" DAY_3DAY_7DAY_14DAY_30 |
bizType | string | Optional | Business category. · Options: XIAOHONGSHU_HOT, PRODUCT_SEEDING, ECOMMERCE_PROMOTION, PUGONGYING_COOPERATION, LEAD_COLLECTION, ECOMMERCE_HOT, SEEDING_DIRECT, APP_PROMOTION · Default: "XIAOHONGSHU_HOT" XIAOHONGSHU_HOTPRODUCT_SEEDINGECOMMERCE_PROMOTIONPUGONGYING_COOPERATIONLEAD_COLLECTIONECOMMERCE_HOTSEEDING_DIRECTAPP_PROMOTION |
orderBy | string | Optional | Ranking metric. · Options: premium_imp_num, premium_good_read_rate, premium_read_num, premium_engage_num, premium_engage_rate, premium_like_num, premium_fav_num, premium_cmt_num · Default: "premium_imp_num" premium_imp_numpremium_good_read_ratepremium_read_numpremium_engage_numpremium_engage_ratepremium_like_numpremium_fav_numpremium_cmt_num |
pageNum | integer | Optional | Page number for results. · Default: 1 |
searchWord | string | Optional | Keyword for note search. Empty string searches all notes. |
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/content-square-search-note-v2", {
method: "POST",
headers: {
Authorization: `Bearer ${apiKey}`,
"Content-Type": "application/json",
},
body: JSON.stringify({
"nd": "DAY_7",
"bizType": "XIAOHONGSHU_HOT",
"orderBy": "premium_imp_num",
"pageNum": 1
}),
});
if (!response.ok) throw new Error(await response.text());
console.log(await response.json());