TikTok for Developers Research Comments API

Comment data operations

OpenAPI Specification

tiktok-for-developers-research-comments-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: TikTok Content Posting OAuth Research Comments API
  description: The TikTok Content Posting API allows third-party platforms to publish videos directly to a user's TikTok account. Supports direct post and file-upload flows, including video initiation, chunk upload, and publish status polling.
  version: v2
  contact:
    name: TikTok for Developers
    url: https://developers.tiktok.com/
  termsOfService: https://developers.tiktok.com/doc/tiktok-api-terms-of-service
servers:
- url: https://open.tiktokapis.com
  description: TikTok Open API Production
security:
- BearerAuth: []
tags:
- name: Research Comments
  description: Comment data operations
paths:
  /v2/research/video/comment/list/:
    post:
      operationId: listVideoComments
      summary: List Video Comments
      description: Retrieves all comments on a specific TikTok video, including comment text, author information, create time, and like count.
      tags:
      - Research Comments
      parameters:
      - name: fields
        in: query
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CommentListRequest'
      responses:
        '200':
          description: Comments returned successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CommentListResponse'
        '401':
          description: Unauthorized
components:
  schemas:
    Comment:
      type: object
      properties:
        id:
          type: string
        video_id:
          type: string
        text:
          type: string
        like_count:
          type: integer
        reply_count:
          type: integer
        parent_comment_id:
          type: string
        create_time:
          type: integer
    CommentListResponse:
      type: object
      properties:
        data:
          type: object
          properties:
            comments:
              type: array
              items:
                $ref: '#/components/schemas/Comment'
            cursor:
              type: integer
            has_more:
              type: boolean
        error:
          $ref: '#/components/schemas/Error'
    Error:
      type: object
      properties:
        code:
          type: string
        message:
          type: string
        log_id:
          type: string
    CommentListRequest:
      type: object
      required:
      - video_id
      - max_count
      properties:
        video_id:
          type: string
          description: TikTok video ID
        max_count:
          type: integer
          minimum: 1
          maximum: 100
        cursor:
          type: integer
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: OAuth 2.0 Bearer token