# 获取视频笔记详情/Get video note detail

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/xiaohongshu/app_v2/get_video_note_detail:
    get:
      summary: 获取视频笔记详情/Get video note detail
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取视频笔记的完整详情数据

        ### ⚠️ 笔记类型说明（重要）:

        - 小红书笔记分为两种类型：`图文笔记（normal）` 和 `视频笔记（video）`，使用时务必区分。

        - 本接口 **只能获取视频笔记的数据**，如果传入图文笔记的 note_id 将无法请求到内容，此限制来自小红书官方。

        - 图文笔记接口 `/get_image_note_detail`
        可以获取图文和视频两种笔记，但对视频笔记不会返回视频文件的播放链接，只会返回视频封面图。

        ### 推荐调用流程（不确定笔记类型时）:

        - 1. 优先请求 `/get_image_note_detail`（图文笔记接口）。

        - 2. 通过响应中的笔记类型字段（如 `type` 是否为 `video`）判断是否为视频笔记。

        - 3. 如果是视频笔记，再使用相同的 note_id 请求本接口获取视频播放地址。

        ### ⚠️ 计费提示:

        - 如果传入错误或不存在的笔记ID（或分享链接解析失败），接口仍会正常响应，但 `data` 中会返回上游"服务异常"信息，该请求
        **同样会正常计费扣费**，请在调用前确保参数有效。

        ### 参数:

        - note_id: 笔记ID，如 "697c0eee000000000a03c308"

        - share_text: 小红书分享链接，支持APP和Web端分享链接，支持 `xiaohongshu.com`
        长链接、`xhslink.com` 和 `xhslink.cn` 短链接

        - 优先使用`note_id`，如果没有则使用`share_text`，两个参数二选一，如都携带则以`note_id`为准。

        ### 返回:

        - 视频笔记详情数据，包含视频播放地址、封面图、作者信息、互动数据等


        # [English]

        ### Purpose:

        - Get full detail data of a video note

        ### ⚠️ Note Type Notice (Important):

        - Xiaohongshu notes come in two types: `image notes (normal)` and `video
        notes (video)`. Make sure to distinguish them when using the APIs.

        - This endpoint can **ONLY fetch data of video notes**. Passing the
        note_id of an image note will fail to get any content. This restriction
        comes from Xiaohongshu official.

        - The image note endpoint `/get_image_note_detail` can fetch both image
        and video notes, but for video notes it will NOT return the video play
        URL, only the video cover image.

        ### Recommended Workflow (when note type is unknown):

        - 1. Request `/get_image_note_detail` (image note endpoint) first.

        - 2. Check the note type field in the response (e.g. whether `type` is
        `video`) to determine if it is a video note.

        - 3. If it is a video note, request this endpoint again with the same
        note_id to get the video play URL.

        ### ⚠️ Billing Notice:

        - If a wrong or non-existent note ID is passed (or the share link fails
        to parse), the endpoint still responds normally, but the `data` field
        will contain an upstream "service error" message. Such requests **will
        still be billed as normal**. Please make sure the parameters are valid
        before calling.

        ### Parameters:

        - note_id: Note ID, e.g. "697c0eee000000000a03c308"

        - share_text: Xiaohongshu sharing link, supports APP and Web sharing
        links, including `xiaohongshu.com` full links, `xhslink.com` and
        `xhslink.cn` short links

        - Prefer to use `note_id`, if not, use `share_text`, one of the two
        parameters is required, if both are carried, `note_id` shall prevail.

        ### Return:

        - Video note detail data, including video play URL, cover image, author
        info, interaction data, etc.


        # [示例/Example]

        note_id="697c0eee000000000a03c308"
      operationId: >-
        get_video_note_detail_api_v1_xiaohongshu_app_v2_get_video_note_detail_get
      tags:
        - Xiaohongshu-App-V2-API
        - Xiaohongshu-App-V2-API
      parameters:
        - name: note_id
          in: query
          description: 笔记ID/Note ID
          required: false
          example: 697c0eee000000000a03c308
          schema:
            type: string
            description: 笔记ID/Note ID
            default: ''
            title: Note Id
        - name: share_text
          in: query
          description: >-
            分享链接，支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports
            xiaohongshu.com, xhslink.com, xhslink.cn
          required: false
          example: http://xhslink.com/o/8GqargIxrko
          schema:
            type: string
            description: >-
              分享链接，支持xiaohongshu.com/xhslink.com/xhslink.cn/Share link, supports
              xiaohongshu.com, xhslink.com, xhslink.cn
            default: ''
            title: Share Text
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
          headers: {}
          x-apifox-name: OK
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          headers: {}
          x-apifox-name: Unprocessable Entity
      security:
        - HTTPBearer: []
          x-apifox:
            schemeGroups:
              - id: wGP0S3_roqilnINxJNKjx
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: wGP0S3_roqilnINxJNKjx
            scopes:
              wGP0S3_roqilnINxJNKjx:
                HTTPBearer: []
      x-apifox-folder: Xiaohongshu-App-V2-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-420136392-run
components:
  schemas:
    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
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
      x-apifox-orders:
        - loc
        - msg
        - type
      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: []

```