> ## Documentation Index
> Fetch the complete documentation index at: https://docs.socq.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Rednote User Notes

> Fetch normalized user notes data from Rednote.

# Get Rednote User Notes

Fetch normalized user notes data from Rednote.

Successful tasks are billed per task.

## Request Body

```json theme={"system"}
{
  "user_id": "65d8c7d40000000005033a6b"
}
```

## Use with MCP

| Interface | Value |
| - | - |
| REST | `POST /v1/rednote/user-notes` |
| Compact MCP | `socq_execute` with `endpoint: "rednote/user-notes"` |
| Typed MCP | `socq_rednote_user_notes` |
| Exact-tool URL | `https://api.socq.ai/mcp?tools=rednote_user_notes` |
| CLI | `socq rednote user-notes` |

> [!NOTE]
>
> A successful request returns a `task_id`. Poll it with `socq_get_task`, then read normalized records from `results.items`.

## Result Fields

| Field | Type | Nullable | Description |
| - | - | - | - |
| `id` | `string` | Yes | Unique identifier for this result item. |
| `platform` | `string` | No | Platform the result belongs to, such as `instagram` or `linkedin`. |
| `resource` | `string` | No | SocQ resource represented by the result, such as `videos` or `comments`. |
| `type` | `string` | No | Category of the result item, such as `video`, `post`, or `comment`. |
| `url` | `string` | Yes | Public URL of the result item when available. |
| `published_at` | `string` | Yes | Time the source item was published, in ISO 8601 format when available. |
| `collected_at` | `string` | No | Time SocQ collected or processed this result, in ISO 8601 format. |
| `text` | `string` | Yes | Post body, caption, or message. |
| `author` | `object` | Yes | Author or publisher of the content. |
| `author` | `object` | No | Field value in the standard result. |
| `author.id` | `string` | Yes | Unique identifier of the author. |
| `author.username` | `string` | Yes | Public username or handle of the account. |
| `author.name` | `string` | Yes | Display name of the author. |
| `author.url` | `string` | Yes | Public URL of the author when available. |
| `author.avatar_url` | `string` | Yes | URL of the account avatar image. |
| `author.is_verified` | `boolean` | Yes | Whether the account is verified on the platform. |
| `author.is_private` | `boolean` | Yes | Whether the account is private. |
| `metrics` | `object` | Yes | Counters and measurements available for the result item. |
| `metrics` | `object` | No | Field value in the standard result. |
| `metrics.likes_count` | `integer` | Yes | Number of likes. |
| `metrics.comments_count` | `integer` | Yes | Number of comments. |
| `metrics.shares_count` | `integer` | Yes | Number of shares or reposts. |
| `metrics.views_count` | `integer` | Yes | Number of views reported by the platform. |
| `media` | `array<object>` | Yes | Images, videos, or other media attached to the result. |
| `hashtags` | `array<string>` | Yes | Hashtags associated with the content, without changing their source spelling. |
| `mentions` | `array<string>` | Yes | Accounts mentioned in the content. |

## Completed Task Response

```json theme={"system"}
{
  "code": 200,
  "message": "success",
  "data": {
    "task_id": "task_example",
    "public_id": "rednote/user-notes",
    "status": "succeeded",
    "result_count": 0,
    "credits_amount": 0,
    "results": {
      "schema_id": "post",
      "schema_version": "1.0",
      "items": [],
      "limit": 20,
      "next_cursor": null,
      "has_more": false
    }
  }
}
```


## OpenAPI

````yaml api-manual/agent-api/agent-api.json POST /v1/rednote/user-notes
openapi: 3.1.0
info:
  title: SocQ Agent API
  version: v1-050b21a3b206
  description: Asynchronous social data API generated from the SocQ Capability Registry.
servers:
  - url: https://api.socq.ai
security: []
paths:
  /v1/rednote/user-notes:
    post:
      tags:
        - rednote
      summary: Rednote User Notes API
      description: Collect one page of public Rednote user notes.
      operationId: socq_rednote_user_notes
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $schema: https://json-schema.org/draft/2020-12/schema
              type: object
              additionalProperties: false
              properties:
                url:
                  type: string
                  minLength: 1
                  description: >-
                    A public Rednote profile URL or xhslink.com/xhslink.cn share
                    link.
                user_id:
                  type: string
                  minLength: 1
                  description: >-
                    A 24-character internal Rednote user ID, not a nickname or
                    Rednote number.
                  pattern: ^[0-9a-fA-F]{24}$
              required: []
              anyOf:
                - required:
                    - url
                - required:
                    - user_id
              allOf:
                - not:
                    required:
                      - url
                      - user_id
      responses:
        '200':
          description: Task accepted
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentSubmitResponse'
        '422':
          description: Input validation failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgentValidationErrorResponse'
      security:
        - bearerAuth: []
        - apiKeyAuth: []
components:
  schemas:
    AgentSubmitResponse:
      type: object
      properties:
        code:
          type: integer
          const: 200
        data:
          type: object
          properties:
            task_id:
              type: string
            status:
              type: string
            created_time:
              type:
                - string
                - 'null'
          required:
            - task_id
            - status
    AgentValidationErrorResponse:
      type: object
      properties:
        code:
          type: integer
          const: 422
        error:
          type: object
          properties:
            message:
              type: string
            type:
              type: string
            details:
              type: object
          required:
            - message
            - type
      required:
        - code
        - error
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.