# 获取视频相似内容/Get related videos

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/youtube/web_v2/get_related_videos:
    get:
      summary: 获取视频相似内容/Get related videos
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取YouTube视频的相似内容推荐（推荐视频列表）

        - 类似于视频播放页面右侧的相关视频

        - 一次性返回所有推荐视频（通常20-30个）


        ### 参数:

        - video_id: 视频ID（推荐）

        - video_url: 完整的视频URL（可选，如果提供video_id则忽略）

        - need_format: 是否格式化数据（默认 true）
          - true: 返回格式化的结构化数据（推荐）
          - false: 返回原始的 YouTube API 结构（用于调试或自定义解析）

        ### 返回数据包含:

        #### 当 need_format=true 时:

        - video_id: 当前视频ID

        - related_videos: 相关视频列表（格式化后的数据）
          - video_id: 相关视频的ID
          - title: 视频标题
          - author: 作者名称
          - author_id: 作者频道ID
          - author_url: 作者频道链接
          - length_text: 视频时长文本（如 "3:45"）
          - length_seconds: 视频时长（秒数）
          - view_count_text: 观看次数文本（如 "1.2M views"）
          - short_view_count_text: 简短观看次数文本（如 "1.2M"）
          - published_time_text: 发布时间文本（如 "2 days ago"）
          - thumbnails: 所有分辨率的缩略图列表
          - rich_thumbnail: 动态缩略图（如果有）
          - badges: 视频徽章（如 NEW、LIVE 等）
          - owner_badges: 作者徽章（如验证标识）
          - video_url: 视频链接
          - navigation_endpoint: 导航端点
        - total_count: 推荐视频总数


        #### 当 need_format=false 时:

        - video_id: 当前视频ID

        - related_videos: 原始的 lockupViewModel 对象列表

        - total_count: 推荐视频总数


        ### 注意事项:

        - 每个视频的推荐内容由 YouTube 算法生成，可能会变化

        - 推荐列表通常包含 20-30 个视频

        - ⚠️ **此接口不支持分页**，一次性返回所有推荐视频


        ### 价格:

        - $0.001 USD / 请求


        # [English]

        ### Purpose:

        - Get YouTube video's related content recommendations (recommended
        videos list)

        - Similar to the related videos shown on the right side of video
        playback page

        - Returns all recommended videos at once (typically 20-30 videos)


        ### Parameters:

        - video_id: Video ID (recommended)

        - video_url: Full video URL (optional, ignored if video_id is provided)

        - need_format: Whether to format data (default true)
          - true: Return formatted structured data (recommended)
          - false: Return raw YouTube API structure (for debugging or custom parsing)

        ### Returns:

        #### When need_format=true:

        - video_id: Current video ID

        - related_videos: Related videos list
          - video_id: Related video's ID
          - title: Video title
          - author: Author name
          - author_id: Author channel ID
          - author_url: Author channel URL
          - length_text: Video duration text (e.g., "3:45")
          - length_seconds: Video duration in seconds
          - view_count_text: View count text (e.g., "1.2M views")
          - short_view_count_text: Short view count text (e.g., "1.2M")
          - published_time_text: Published time text (e.g., "2 days ago")
          - thumbnails: All resolution thumbnails
          - rich_thumbnail: Moving thumbnail (if available)
          - badges: Video badges (e.g., NEW, LIVE)
          - owner_badges: Channel verification badges
          - video_url: Video URL
          - navigation_endpoint: Navigation endpoint
        - total_count: Total number of recommended videos


        #### When need_format=false:

        - video_id: Current video ID

        - related_videos: Raw lockupViewModel object list

        - total_count: Total number of recommended videos


        ### Notes:

        - Each video's recommendations are generated by YouTube's algorithm and
        may change

        - Recommendation list typically contains 20-30 videos

        - ⚠️ **This API does not support pagination**, returns all
        recommendations at once


        ### Price:

        - $0.001 USD / request


        ### [示例/Example]

        #### 获取推荐视频: video_id = "dQw4w9WgXcQ"
      operationId: get_related_videos_api_v1_youtube_web_v2_get_related_videos_get
      tags:
        - YouTube-Web-V2-API
        - YouTube-Web-V2-API
      parameters:
        - name: video_id
          in: query
          description: 视频ID/Video ID
          required: false
          example: dQw4w9WgXcQ
          schema:
            type: string
            description: 视频ID/Video ID
            title: Video Id
        - name: video_url
          in: query
          description: 视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is provided)
          required: false
          example: https://www.youtube.com/watch?v=dQw4w9WgXcQ
          schema:
            type: string
            description: >-
              视频URL/Video URL (如果提供video_id则忽略此参数/Ignored if video_id is
              provided)
            title: Video Url
        - name: need_format
          in: query
          description: >-
            是否格式化数据。true: 返回格式化的结构化数据，false: 返回原始API结构/Whether to format data.
            true: return formatted structured data, false: return raw API
            structure
          required: false
          schema:
            type: boolean
            description: >-
              是否格式化数据。true: 返回格式化的结构化数据，false: 返回原始API结构/Whether to format data.
              true: return formatted structured data, false: return raw API
              structure
            default: true
            title: Need Format
      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: bdol7eSBhYOtKnEncRsGL
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: bdol7eSBhYOtKnEncRsGL
            scopes:
              bdol7eSBhYOtKnEncRsGL:
                HTTPBearer: []
      x-apifox-folder: YouTube-Web-V2-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-419083093-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--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--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--orders:
        - detail
      x--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--orders:
        - loc
        - msg
        - type
      x--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: []

```