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

# Search Xiaohongshu notes

> Use this operation to search Xiaohongshu notes. Pagination: omit cursor on the first request. When has_more is true, pass next_cursor unchanged as cursor. Cursors are opaque; do not construct, modify, or reuse them outside this pagination flow.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/redbook/search
openapi: 3.1.0
info:
  description: >-
    Direct authenticated APIs for public social data, people data, transcripts,
    documents, text, and SEO. Send an API key as a Bearer token. Responses never
    include provider credentials or raw provider payloads.
  license:
    name: Proprietary
    url: https://agentbody.io
  title: AgentBody API
  version: '2026-08-19'
servers:
  - url: https://api.agentbody.io
security:
  - bearerAuth: []
paths:
  /v1/redbook/search:
    get:
      tags:
        - redbook
      summary: Search Xiaohongshu notes
      description: >-
        Use this operation to search Xiaohongshu notes. Pagination: omit cursor
        on the first request. When has_more is true, pass next_cursor unchanged
        as cursor. Cursors are opaque; do not construct, modify, or reuse them
        outside this pagination flow.
      operationId: get_v1_redbook_search
      parameters:
        - $ref: '#/components/parameters/Query'
        - $ref: '#/components/parameters/SortType'
        - $ref: '#/components/parameters/NoteType'
        - $ref: '#/components/parameters/TimeFilter'
        - $ref: '#/components/parameters/Cursor'
      responses:
        '200':
          content:
            application/json:
              example:
                has_more: false
                items: []
                next_cursor: example_value
              schema:
                $ref: '#/components/schemas/ListResult'
          description: Successful Gateway result.
          headers:
            X-Request-Id:
              description: Gateway request identifier for support and audit.
              schema:
                format: uuid
                type: string
        '400':
          content:
            application/json:
              example:
                error:
                  code: INVALID_ARGUMENT
                  message: example error
              schema:
                additionalProperties: false
                properties:
                  error:
                    additionalProperties: false
                    properties:
                      code:
                        const: INVALID_ARGUMENT
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Correct the input; do not retry unchanged.
          headers:
            X-Request-Id:
              description: Gateway request identifier for support and audit.
              schema:
                format: uuid
                type: string
        '401':
          content:
            application/json:
              example:
                error:
                  code: UNAUTHENTICATED
                  message: example error
              schema:
                additionalProperties: false
                properties:
                  error:
                    additionalProperties: false
                    properties:
                      code:
                        const: UNAUTHENTICATED
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Configure a valid API key; do not retry unchanged.
          headers:
            X-Request-Id:
              description: Gateway request identifier for support and audit.
              schema:
                format: uuid
                type: string
        '402':
          content:
            application/json:
              example:
                error:
                  code: INSUFFICIENT_BALANCE
                  message: example error
              schema:
                additionalProperties: false
                properties:
                  error:
                    additionalProperties: false
                    properties:
                      code:
                        const: INSUFFICIENT_BALANCE
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Recharge required; do not retry.
          headers:
            X-Request-Id:
              description: Gateway request identifier for support and audit.
              schema:
                format: uuid
                type: string
        '502':
          content:
            application/json:
              example:
                error:
                  code: UPSTREAM_INVALID_RESPONSE
                  message: example error
              schema:
                additionalProperties: false
                properties:
                  error:
                    additionalProperties: false
                    properties:
                      code:
                        const: UPSTREAM_INVALID_RESPONSE
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Retry with backoff, then report temporary unavailability.
          headers:
            X-Request-Id:
              description: Gateway request identifier for support and audit.
              schema:
                format: uuid
                type: string
        '503':
          content:
            application/json:
              example:
                error:
                  code: UPSTREAM_UNAVAILABLE
                  message: example error
              schema:
                additionalProperties: false
                properties:
                  error:
                    additionalProperties: false
                    properties:
                      code:
                        const: UPSTREAM_UNAVAILABLE
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Retry with backoff, then report temporary unavailability.
          headers:
            X-Request-Id:
              description: Gateway request identifier for support and audit.
              schema:
                format: uuid
                type: string
        '504':
          content:
            application/json:
              example:
                error:
                  code: UPSTREAM_TIMEOUT
                  message: example error
              schema:
                additionalProperties: false
                properties:
                  error:
                    additionalProperties: false
                    properties:
                      code:
                        const: UPSTREAM_TIMEOUT
                        type: string
                      message:
                        type: string
                    required:
                      - code
                      - message
                    type: object
                required:
                  - error
                type: object
          description: Retry with backoff, then report temporary unavailability.
          headers:
            X-Request-Id:
              description: Gateway request identifier for support and audit.
              schema:
                format: uuid
                type: string
components:
  parameters:
    Query:
      description: >-
        Search phrase supplied by the user. Do not include provider-specific
        query syntax unless documented by the operation.
      example: openai
      in: query
      name: query
      required: true
      schema:
        maxLength: 500
        minLength: 1
        type: string
    SortType:
      description: >-
        Optional redbook note search ranking. Omit it for the platform default
        (general).
      in: query
      name: sort_type
      required: false
      schema:
        enum:
          - general
          - time_descending
          - popularity_descending
          - comment_descending
          - collect_descending
          - english_preferred
        type: string
    NoteType:
      description: Optional redbook note search type filter.
      in: query
      name: note_type
      required: false
      schema:
        enum:
          - all
          - video
          - normal
          - live
        type: string
    TimeFilter:
      description: Optional redbook note search publish-time filter.
      in: query
      name: time_filter
      required: false
      schema:
        enum:
          - all
          - day
          - week
          - half_year
        type: string
    Cursor:
      description: >-
        Opaque cursor returned by the preceding response. Omit it on the first
        request. Do not construct, modify, or reuse it outside this pagination
        flow.
      example: next-page-token
      in: query
      name: cursor
      required: false
      schema:
        maxLength: 1000
        type: string
  schemas:
    ListResult:
      additionalProperties: false
      properties:
        has_more:
          type: boolean
        items:
          items:
            $ref: '#/components/schemas/SocialObject'
          type: array
        next_cursor:
          type:
            - string
            - 'null'
      required:
        - items
        - next_cursor
        - has_more
      type: object
    SocialObject:
      additionalProperties: false
      properties:
        created_at:
          type: string
        id:
          type: string
        media_type:
          type: string
        metrics:
          additionalProperties: false
          properties:
            comments:
              type: integer
            followers:
              type: integer
            following:
              type: integer
            likes:
              type: integer
            posts:
              type: integer
            shares:
              type: integer
            views:
              type: integer
          type: object
        name:
          type: string
        text:
          type: string
        url:
          type: string
        username:
          type: string
      type: object
  securitySchemes:
    bearerAuth:
      scheme: bearer
      type: http

````