# Note comments

Fetch a note's top-level comments. For replies under one comment use xhs_comment_sub_comments_v1.

ID: native-http:social.xhs.note.comments · Region: global · Status: available

catalog_version: 1d0d6a1c969fdf327cc670c6e09e30955e8d31a1effc0d3a58d90184ad911f57
updated_at: 2026-10-27T04:03:01.944414+00:00

Fetch a note's top-level comments. For replies under one comment use xhs_comment_sub_comments_v1.

Dataset releases define historical periods; live reads describe request-time data and do not guarantee completeness.

Docs: https://docs.kleardata.ai/capabilities/native-http%3Asocial.xhs.note.comments

## POST /v1/native/social/xhs/notes/comments

native · available · api_key

REST requires a customer API Key; MCP requires an enabled authenticated server; CLI requires its published artifact and command.

Fetch a note's top-level comments. For replies under one comment use xhs_comment_sub_comments_v1.

Charge once per successful request under the approved customer price policy; max_credits bounds the charge.

Reuse the original Idempotency-Key when recovering the same native request.

Read the original task before retrying a pending or unknown outcome. Check error.code before acting on HTTP 401/402/403/422: native_upstream_* reports a source failure; keep job_id/request_id and contact support. These source errors do not establish a problem with your Asklear API Key, Credits, permissions or input. Correct Asklear authentication, permission or input errors before retrying; do not automatically resubmit paid execution.

### Input schema / 输入契约

```json
{
  "$defs": {
    "Schema1": {}
  },
  "additionalProperties": false,
  "properties": {
    "input": {
      "additionalProperties": false,
      "properties": {
        "cursor": {
          "default": "",
          "maxLength": 512,
          "pattern": "^[\\x20-\\x7e]*$",
          "type": "string"
        },
        "note_id": {
          "maxLength": 128,
          "minLength": 1,
          "pattern": "^[A-Za-z0-9_-]+$",
          "type": "string"
        },
        "sort": {
          "default": "default",
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "note_id"
      ],
      "type": "object"
    },
    "max_credits": {
      "anyOf": [
        {
          "maximum": 1000000000,
          "minimum": 0,
          "type": "integer"
        },
        {
          "type": "null"
        }
      ],
      "default": null
    },
    "task_query": {
      "anyOf": [
        {
          "anyOf": [
            {
              "type": "string"
            },
            {
              "type": "null"
            }
          ],
          "default": null,
          "description": "Optional task attribution: when provided, write one concise, self-contained task_query in the user's language and reuse that exact value in every call for the task, including discovery, search, approval retry, results, export, and status checks. For MCP calls, when omitted, Asklear records a generic non-user-specific attribution so compatible clients can still call the tool. REST calls may omit it and remain unattributed. It is a task description, not a task identifier. Do not include hidden reasoning, credentials, or direct personal identifiers such as phone numbers, email addresses, identity numbers, or street addresses.",
          "maxLength": 300
        },
        {
          "type": "null"
        }
      ],
      "default": null
    }
  },
  "required": [
    "input"
  ],
  "type": "object"
}
```

### Synthetic request / 合成请求

```json
{
  "input": {
    "note_id": "sph_example"
  }
}
```

### Response schema / 响应契约

```json
{
  "$defs": {
    "Schema1": {},
    "Schema2": {
      "properties": {
        "api_name": {
          "type": "string"
        },
        "credits_charged": {
          "minimum": 0,
          "type": "integer"
        },
        "latency_ms": {
          "minimum": 0,
          "type": "integer"
        },
        "next_input": {
          "anyOf": [
            {
              "additionalProperties": false,
              "properties": {
                "cursor": {
                  "default": "",
                  "maxLength": 512,
                  "pattern": "^[\\x20-\\x7e]*$",
                  "type": "string"
                },
                "note_id": {
                  "maxLength": 128,
                  "minLength": 1,
                  "pattern": "^[A-Za-z0-9_-]+$",
                  "type": "string"
                },
                "sort": {
                  "default": "default",
                  "maxLength": 64,
                  "type": "string"
                }
              },
              "required": [
                "note_id"
              ],
              "type": "object"
            },
            {
              "type": "null"
            }
          ]
        },
        "request_id": {
          "type": "string"
        }
      },
      "required": [
        "api_name",
        "request_id",
        "latency_ms",
        "credits_charged",
        "next_input"
      ],
      "type": "object"
    }
  },
  "properties": {
    "data": {
      "additionalProperties": true,
      "description": "Known optional fields from sanitized offline fixtures; conditional fields may be null. Additional business fields are retained.",
      "properties": {
        "data": {
          "additionalProperties": true,
          "properties": {
            "comments": {
              "items": {
                "additionalProperties": true,
                "properties": {
                  "content": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "id": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "like_count": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "note_id": {
                    "type": [
                      "string",
                      "null"
                    ]
                  },
                  "sub_comment_count": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "time": {
                    "type": [
                      "integer",
                      "null"
                    ]
                  },
                  "user": {
                    "additionalProperties": true,
                    "properties": {
                      "nickname": {
                        "type": [
                          "string",
                          "null"
                        ]
                      },
                      "userid": {
                        "type": [
                          "string",
                          "null"
                        ]
                      }
                    },
                    "type": [
                      "object",
                      "null"
                    ]
                  }
                },
                "type": [
                  "object",
                  "null"
                ]
              },
              "type": [
                "array",
                "null"
              ]
            },
            "has_more": {
              "type": [
                "boolean",
                "null"
              ]
            },
            "next_cursor": {
              "type": [
                "string",
                "null"
              ]
            }
          },
          "type": [
            "object",
            "null"
          ]
        }
      },
      "type": "object"
    },
    "meta": {
      "$ref": "#/$defs/Schema2"
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "type": "object"
}
```

### Synthetic response / 合成响应

```json
{
  "data": {
    "data": {
      "comments": [
        {
          "content": "评论",
          "id": "comment-1",
          "like_count": 2,
          "note_id": "note-1",
          "sub_comment_count": 1,
          "time": 1700000001,
          "user": {
            "nickname": "作者",
            "userid": "author-1"
          }
        }
      ],
      "has_more": false
    }
  },
  "meta": {
    "api_name": "social.xhs.note.comments",
    "credits_charged": 8,
    "latency_ms": 12,
    "next_input": null,
    "request_id": "asklear-example"
  }
}
```

- data (object): Known optional fields from sanitized offline fixtures; conditional fields may be null. Additional business fields are retained.
- data.data (object|null): No field description available
- data.data.comments (array|null): No field description available
- data.data.has_more (boolean|null): No field description available
- data.data.next_cursor (string|null): No field description available
- meta (object): No field description available
- meta.api_name (string): No field description available
- meta.request_id (string): No field description available
- meta.latency_ms (integer): No field description available
- meta.credits_charged (integer): No field description available
- meta.next_input (scalar): No field description available
- data.data.comments[].content (string|null): Content, when available.
- data.data.comments[].id (string|null): Comment identifier, when available.
- data.data.comments[].like_count (integer|null): Like count, when available.
- data.data.comments[].note_id (string|null): Note id, when available.
- data.data.comments[].sub_comment_count (integer|null): Sub comment count, when available.
- data.data.comments[].time (integer|null): Publish time, when available.
- data.data.comments[].user (object|null): No field description available
- data.data.comments[].user.nickname (string|null): Display name, when available.
- data.data.comments[].user.userid (string|null): Comment speaker's user ID; compare with the note detail author.user_id only when both are nonempty. Otherwise the author match is unknown. The native Task counterpart is extended_data.author_id.
- meta.next_input.cursor (string): No field description available
- meta.next_input.note_id (string): No field description available
- meta.next_input.sort (string): No field description available

Follow up: GET /v1/native/results/{query_id}
Read the saved result without another source call.

