# 获取蒲公英笔记详情/Get PGY note detail ## OpenAPI Specification ```yaml openapi: 3.0.1 info: title: '' description: '' version: 1.0.0 paths: /api/v1/xiaohongshu/pgy/get_note_detail: post: summary: 获取蒲公英笔记详情/Get PGY note detail deprecated: false description: >- # [中文] ### 用途: - 获取单篇蒲公英笔记的详情数据 ### 请求体参数: - note_id: 笔记ID，如 "6a20edfa0000000021020951" ### 返回: - 笔记详情数据，主要字段: - 笔记基础: noteId / noteLink / title / content(正文) / type(类型) / createTime - 作者: userId / name / headPhoto - 媒体: imagesList[](图片url与宽高) / videoInfo(视频) - 互动数据: impNum(曝光) / readNum(阅读) / likeNum(点赞) / favNum(收藏) / cmtNum(评论) ### 响应结构（取数要剥两层）: - `resp["data"]` 是蒲公英原样信封（含 `code`/`msg`/`success`），业务数据还在它里面一层 - 正确取法：`data = resp["data"]["data"]`；下面「返回」列的字段都在这一层下 ### 计费: - HTTP 200 → **计费**。包含「查无结果」（`data` 为 null，如 ID 不存在或筛选无命中）—— 请求已送达蒲公英，同样扣费，不要因为拿不到数据就重试 - HTTP 400 → 不计费（参数格式非法，或上游资源不足/异常） # [English] ### Purpose: - Get detail data of a single PGY (Pugongying) note ### Request Body Parameters: - note_id: Note ID, e.g. "6a20edfa0000000021020951" ### Return: - Note detail data: - Basics: noteId / noteLink / title / content / type / createTime - Author: userId / name / headPhoto - Media: imagesList[] (url with width/height) / videoInfo - Metrics: impNum / readNum / likeNum / favNum / cmtNum ### Response shape (two layers): - `resp["data"]` is PGY's raw envelope (with `code`/`msg`/`success`); the payload is one level deeper - Correct access: `data = resp["data"]["data"]` — every field listed under "Return" lives here ### Billing: - HTTP 200 → **charged**, including "no result" (`data` is null, e.g. ID not found or filters matched nothing): the request did reach PGY, so retrying on empty data just burns quota - HTTP 400 → not charged (malformed params, or upstream unavailable/error) # [示例/Example] ```json {"note_id": "6a20edfa0000000021020951"} ``` `note_id` 从 `/get_blogger_notes` 的 `list[].noteId`、`/get_blogger_notes_v2` 的 `noteList[].noteInfo.noteId`，或 `/get_content_square` 的榜单结果里取。 Get `note_id` from `/get_blogger_notes`, `/get_blogger_notes_v2` or `/get_content_square` results. operationId: get_note_detail_api_v1_xiaohongshu_pgy_get_note_detail_post tags: - Xiaohongshu-PGY-API - Xiaohongshu-PGY-API parameters: [] requestBody: content: application/json: schema: $ref: '#/components/schemas/NoteDetailReq' responses: '200': description: Successful Response content: application/json: schema: $ref: '#/components/schemas/ResponseModel' headers: {} x-apifox-name: '' '422': description: Validation Error content: application/json: schema: $ref: '#/components/schemas/HTTPValidationError' headers: {} x-apifox-name: '' security: - HTTPBearer: [] x-apifox: schemeGroups: - id: vb6xB9ACJq8MPb73k3JDk schemeIds: - HTTPBearer required: true use: id: vb6xB9ACJq8MPb73k3JDk scopes: vb6xB9ACJq8MPb73k3JDk: HTTPBearer: [] x-apifox-folder: Xiaohongshu-PGY-API x-apifox-status: released x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-479321007-run components: schemas: NoteDetailReq: properties: note_id: type: string title: Note Id description: 笔记ID/Note ID examples: - 6a20edfa0000000021020951 additionalProperties: false type: object required: - note_id title: NoteDetailReq x-apifox-orders: - note_id x-apifox-ignore-properties: [] x-apifox-folder: '' ResponseModel: properties: code: type: integer title: Code description: HTTP status code | HTTP状态码 default: 200 request_id: anyOf: - type: string - type: 'null' title: Request Id description: Unique request identifier | 唯一请求标识符 message: type: string title: Message description: Response message (EN-US) | 响应消息 (English) default: Request successful. This request will incur a charge. message_zh: type: string title: Message Zh description: Response message (ZH-CN) | 响应消息 (中文) default: 请求成功，本次请求将被计费。 support: type: string title: Support description: Support message | 支持消息 default: 'Discord: https://discord.gg/aMEAS8Xsvz' time: type: string title: Time description: The time the response was generated | 生成响应的时间 time_stamp: type: integer title: Time Stamp description: The timestamp the response was generated | 生成响应的时间戳 time_zone: type: string title: Time Zone description: The timezone of the response time | 响应时间的时区 default: America/Los_Angeles docs: anyOf: - type: string - type: 'null' title: Docs description: >- Link to the API Swagger documentation for this endpoint | 此端点的 API Swagger 文档链接 cache_message: anyOf: - type: string - type: 'null' title: Cache Message description: Cache message (EN-US) | 缓存消息 (English) default: >- This response is cached and accessible via the URL below for 24 hours at no extra cost. The cache is for request tracing only — it doesn't affect the API's data freshness and won't be returned through the API again. cache_message_zh: anyOf: - type: string - type: 'null' title: Cache Message Zh description: Cache message (ZH-CN) | 缓存消息 (中文) default: >- 本次响应已缓存，可通过下方 URL 直接查看，有效期 24 小时，访问缓存链接无额外费用。缓存仅用于请求溯源，不影响接口数据的时效性，也不会再次通过接口返回。 cache_url: anyOf: - type: string - type: 'null' title: Cache Url description: The URL to access the cached result | 访问缓存结果的 URL router: type: string title: Router description: The endpoint that generated this response | 生成此响应的端点 default: '' params: type: string data: anyOf: - type: string - type: 'null' title: Data description: The response data | 响应数据 type: object title: ResponseModel x-apifox-orders: - code - request_id - message - message_zh - support - time - time_stamp - time_zone - docs - cache_message - cache_message_zh - cache_url - router - params - data x-apifox-ignore-properties: [] x-apifox-folder: '' HTTPValidationError: properties: detail: items: $ref: '#/components/schemas/ValidationError' type: array title: Detail type: object title: HTTPValidationError x-apifox-orders: - detail x-apifox-ignore-properties: [] x-apifox-folder: '' ValidationError: properties: loc: items: anyOf: - type: string - type: integer type: array title: Location msg: type: string title: Message type: type: string title: Error Type input: type: string ctx: type: object title: Context x-apifox-orders: [] properties: {} x-apifox-ignore-properties: [] type: object required: - loc - msg - type title: ValidationError x-apifox-orders: - loc - msg - type - input - ctx x-apifox-ignore-properties: [] x-apifox-folder: '' securitySchemes: HTTPBearer: type: bearer description: > ---- #### API Token Introduction: ##### Method 1: Use API Token in the Request Header (Recommended) - **Header**: `Authorization` - **Format**: `Bearer {token}` - **Example**: `{"Authorization": "Bearer your_token"}` - **Swagger UI**: Click on the `Authorize` button in the upper right corner of the page to enter the API token directly without the `Bearer` keyword. ##### Method 2: Use API Token in the Cookie (Not Recommended, Use Only When Method 1 is Unavailable) - **Cookie**: `Authorization` - **Format**: `Bearer {token}` - **Example**: `Authorization=Bearer your_token` #### Get API Token: 1. Register and log in to your account on the TikHub website. 2. Go to the user center, click on the API token menu, and create an API token. 3. Copy and use the API token in the request header. 4. Keep your API token confidential and use it only in the request header. ---- #### API令牌简介: ##### 方法一：在请求头中使用API令牌（推荐） - **请求头**: `Authorization` - **格式**: `Bearer {token}` - **示例**: `{"Authorization": "Bearer your_token"}` - **Swagger UI**: 点击页面右上角的`Authorize`按钮，直接输入API令牌，不需要`Bearer`关键字。 ##### 方法二：在Cookie中使用API令牌（不推荐，仅在无法使用方法一时使用） - **Cookie**: `Authorization` - **格式**: `Bearer {token}` - **示例**: `Authorization=Bearer your_token` #### 获取API令牌: 1. 在TikHub网站注册并登录账户。 2. 进入用户中心，点击API令牌菜单，创建API令牌。 3. 复制并在请求头中使用API令牌。 4. 保密您的API令牌，仅在请求头中使用。 scheme: bearer servers: - url: https://api.tikhub.io description: Production Environment security: [] ```