# 获取视频字幕/Get video captions

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/youtube/web_v2/get_video_captions:
    get:
      summary: 获取视频字幕/Get video captions
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取视频的字幕列表或指定语言的字幕内容

        - 支持多种字幕格式输出


        ### 参数:

        - video_id: 视频ID（推荐）

        - video_url: 完整的视频URL（可选）

        - language_code: 语言代码（如 en, zh-Hans, a.en），为空时返回可用字幕列表

        - format: 字幕格式
          - srt: SubRip 字幕格式（带时间轴）
          - xml: 原始 XML 格式
          - json3: JSON 格式（YouTube 原始结构）
          - txt: 纯文本（无时间轴）

        ### 使用流程:

        1. 不传 language_code，获取字幕列表

        2. 从列表中选择 language_code，获取字幕内容


        ### 返回数据:

        #### 不传 language_code 时（字幕语言列表）:

        ```json

        {
          "video_id": "dQw4w9WgXcQ",
          "captions": [
            { "language_code": "en", "language_name": "English" },
            { "language_code": "ja", "language_name": "Japanese" }
          ]
        }

        ```


        #### 传 language_code 时（字幕内容）:

        - format=srt: 标准 SRT 字幕文件内容（含序号、时间轴、文本）

        - format=txt: 纯文本（仅文字，无时间轴）

        - format=xml: YouTube 原始 XML 字幕

        - format=json3: YouTube JSON 格式字幕


        #### 视频较大时（转异步任务）:

        ```json

        {
          "video_id": "dQw4w9WgXcQ",
          "status": "processing",
          "job_id": "123e4567-e89b-12d3-a456-426614174000"
        }

        ```

        - 返回 `status="processing"` 时，用 `job_id` 调用 `/get_video_captions_result`
        取最终字幕


        #### 视频无字幕时:

        ```json

        {
          "video_id": "dQw4w9WgXcQ",
          "captions": [],
          "message": "No transcript is available for this video",
          "message_zh": "该视频没有可用字幕"
        }

        ```


        ### 注意事项:

        - 并非所有视频都有字幕

        - 仅返回视频本身已有的字幕，不提供 AI 语音转写生成；视频没有字幕时直接返回上述无字幕结果

        - video_id 和 video_url 至少提供一个

        - 大视频会转为异步任务，需配合 `/get_video_captions_result` 轮询获取结果

        - 视频无字幕时返回 200 + 上述提示，且照常计费（上游已对该请求计费）


        ### 价格:

        - $0.008 USD / 请求


        # [English]

        ### Purpose:

        - Get video caption list or caption content for a specific language

        - Supports multiple caption format outputs


        ### Parameters:

        - video_id: Video ID (recommended)

        - video_url: Full video URL (optional)

        - language_code: Language code (e.g. en, zh-Hans, a.en), returns
        available caption list if empty

        - format: Caption format
          - srt: SubRip subtitle format (with timestamps)
          - xml: Raw XML format
          - json3: JSON format (YouTube raw structure)
          - txt: Plain text (no timestamps)

        ### Returns:

        #### Without language_code (caption language list):

        ```json

        {
          "video_id": "dQw4w9WgXcQ",
          "captions": [
            { "language_code": "en", "language_name": "English" },
            { "language_code": "ja", "language_name": "Japanese" }
          ]
        }

        ```


        #### With language_code (caption content):

        - format=srt: Standard SRT subtitle content (with sequence numbers,
        timestamps, text)

        - format=txt: Plain text (text only, no timestamps)

        - format=xml: YouTube raw XML captions

        - format=json3: YouTube JSON format captions


        #### Large videos (async job):

        ```json

        {
          "video_id": "dQw4w9WgXcQ",
          "status": "processing",
          "job_id": "123e4567-e89b-12d3-a456-426614174000"
        }

        ```

        - When `status="processing"` is returned, poll
        `/get_video_captions_result`
          with the `job_id` to retrieve the final captions

        #### Video has no captions:

        ```json

        {
          "video_id": "dQw4w9WgXcQ",
          "captions": [],
          "message": "No transcript is available for this video",
          "message_zh": "该视频没有可用字幕"
        }

        ```


        ### Usage flow:

        1. Call without language_code to get available caption list

        2. Select language_code from the list to get caption content


        ### Notes:

        - Not all videos have captions

        - Only captions that already exist on the video are returned; AI
        speech-to-text
          transcription is not provided. Videos without captions return the no-captions
          result shown above
        - At least one of video_id or video_url is required

        - Large videos become async jobs; poll `/get_video_captions_result` for
        the result

        - A video with no captions returns 200 with the message above and is
        still
          billed (the upstream provider charges for this request)

        ### Price:

        - $0.008 USD / request


        # [示例/Example]

        #### Step 1 - 获取字幕列表: GET /get_video_captions?video_id=dQw4w9WgXcQ

        #### Step 2 - 获取字幕内容: GET
        /get_video_captions?video_id=dQw4w9WgXcQ&language_code=en&format=srt
      operationId: get_video_captions_api_v1_youtube_web_v2_get_video_captions_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
          required: false
          example: https://www.youtube.com/watch?v=dQw4w9WgXcQ
          schema:
            type: string
            description: 视频URL/Video URL
            title: Video Url
        - name: language_code
          in: query
          description: >-
            语言代码，为空时返回可用字幕列表/Language code, returns available caption list if
            empty
          required: false
          example: en
          schema:
            type: string
            description: >-
              语言代码，为空时返回可用字幕列表/Language code, returns available caption list if
              empty
            title: Language Code
        - name: format
          in: query
          description: 字幕格式/Caption format
          required: false
          example: srt
          schema:
            enum:
              - srt
              - xml
              - json3
              - txt
            type: string
            description: 字幕格式/Caption format
            default: srt
            title: Format
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseModel'
          headers: {}
          x-apifox-name: ''
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
          headers: {}
          x-apifox-name: ''
      security:
        - HTTPBearer: []
          x-apifox:
            schemeGroups:
              - id: _G22kFen5VIe5sCtyYjSM
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: _G22kFen5VIe5sCtyYjSM
            scopes:
              _G22kFen5VIe5sCtyYjSM:
                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-431829301-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: []

```