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

# Tik-tok Video

> This endpoint is used to fetch reviews from tiktok for a specified business.



## OpenAPI

````yaml POST /tiktok/video
openapi: 3.1.0
info:
  title: OpenAPI Plant Store
  description: >-
    A sample API that uses a plant store as an example to demonstrate features
    in the OpenAPI specification
  license:
    name: MIT
  version: 1.0.0
servers:
  - url: https://api.hobbo.ai
    description: Main API server
  - url: https://py-api.hobbo.ai
    description: Python API server for scraper endpoints
security:
  - ApiKeyAuth: []
paths:
  /tiktok/video:
    post:
      description: >-
        This endpoint is used to fetch reviews from tiktok for a specified
        business.
      requestBody:
        description: tiktok review scraping parameters
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TikTokVideoRequest'
        required: true
      responses:
        '200':
          description: Post fetched successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TikTokVideoResponse'
              examples:
                validationError:
                  value:
                    all_reviews: []
                    extra_information: {}
                    message: <string>
        '400':
          description: Validation error or unexpected error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              examples:
                validationError:
                  value:
                    error: <string>
      servers:
        - url: https://py-api.hobbo.ai
components:
  schemas:
    TikTokVideoRequest:
      type: object
      required:
        - query
      properties:
        query:
          type: string
          description: Provide a proper tiktok video URL.
        is_text_formatted:
          type: boolean
          description: 'returns the review text with visual formatting preserved '
    TikTokVideoResponse:
      type: object
      properties:
        all_reviews:
          type: array
          description: Array of fetched videos from TikTok
          items:
            type: object
            properties:
              author_id:
                type: string
                description: Unique identifier for the video author
              author_name:
                type: string
                description: Display name of the video author
              author_profile_description:
                type: string
                description: Bio/description from the author's profile
              author_profile_id:
                type: string
                description: TikTok username/handle of the author
              author_profile_image_url:
                type: string
                format: uri
                description: URL of the author's HD profile image
              author_profile_image_url_org:
                type: string
                format: uri
                description: URL of the author's profile image
              author_profile_stats:
                type: object
                description: Statistics for the author's profile
                properties:
                  author_digg_count:
                    type: integer
                    description: Number of videos the author has liked
                  author_followers_count:
                    type: integer
                    description: Number of followers
                  author_following_count:
                    type: integer
                    description: Number of accounts the author follows
                  author_likes_count:
                    type: integer
                    description: Total likes received by the author
                  author_videos_count:
                    type: integer
                    description: Number of videos uploaded by the author
              challenges:
                type: array
                description: Array of challenges/hashtags associated with the video
                items:
                  type: object
                  properties:
                    desc:
                      type: string
                      description: Description of the challenge
                    id:
                      type: string
                      description: Unique identifier for the challenge
                    stats:
                      type: object
                      properties:
                        videoCount:
                          type: integer
                          description: Number of videos using this challenge
                    title:
                      type: string
                      description: Title/name of the challenge
              is_verified_profile:
                type: boolean
                description: Whether the author's profile is verified
              music_details:
                type: object
                description: Details about the music/audio used in the video
                properties:
                  music_album:
                    type:
                      - string
                      - 'null'
                    description: Album name if applicable
                  music_author:
                    type: string
                    description: Author/creator of the music
                  music_cover_page_url:
                    type: string
                    format: uri
                    description: URL of the music cover image
                  music_duration:
                    type: integer
                    description: Duration of the music in seconds
                  music_id:
                    type: string
                    description: Unique identifier for the music
                  music_title:
                    type: string
                    description: Title of the music track
                  music_url:
                    type: string
                    format: uri
                    description: URL to the music file
              query:
                type: string
                format: uri
                description: Original query URL used to fetch the video
              text_extra:
                type: array
                description: >-
                  Array of text elements with metadata (hashtags, mentions,
                  etc.)
                items:
                  type: object
                  properties:
                    awemeId:
                      type: string
                      description: Aweme ID if applicable
                    end:
                      type: integer
                      description: End position of the text element
                    hashtagId:
                      type: string
                      description: ID of the hashtag if applicable
                    hashtagName:
                      type: string
                      description: Name of the hashtag
                    isCommerce:
                      type: boolean
                      description: Whether the text element is commerce-related
                    start:
                      type: integer
                      description: Start position of the text element
                    subType:
                      type: integer
                      description: Sub-type of the text element
                    type:
                      type: integer
                      description: Type of the text element (1 for hashtag, etc.)
              video_anchors:
                type: object
                description: Object containing video anchors/links
              video_cover:
                type: string
                format: uri
                description: URL of the video cover/thumbnail image
              video_date:
                type: string
                description: Date when the video was uploaded
                format: date-time
              video_description:
                type: string
                description: HTML description of the video
              video_duration:
                type: integer
                description: Duration of the video in seconds
              video_height:
                type: integer
                description: Height of the video in pixels
              video_id:
                type: string
                description: Unique identifier for the video
              video_labels:
                type: array
                description: Array of labels associated with the video
                items:
                  type: string
              video_location_created:
                type: string
                description: Location/country code where the video was created
              video_src:
                type: string
                format: uri
                description: URL to the video player
              video_stats:
                type: object
                description: Engagement statistics for the video
                properties:
                  comments_count:
                    type: integer
                    description: Number of comments on the video
                  likes_count:
                    type: integer
                    description: Number of likes
                  saved_count:
                    type: integer
                    description: Number of saves/bookmarks
                  shares_count:
                    type: integer
                    description: Number of shares
                  views_count:
                    type: integer
                    description: Number of views
              video_text:
                type: array
                description: Array of text overlays in the video
                items:
                  type: string
              video_width:
                type: integer
                description: Width of the video in pixels
              video_zoom_cover:
                type: string
                format: uri
                description: URL of the zoomed video cover image
              warn_info:
                type: array
                description: Array of warning information for the video
                items:
                  type: string
    Error:
      type: object
      properties:
        status:
          type: integer
          description: HTTP status code
        data:
          type: object
          description: Empty object or additional error data
        success:
          type: boolean
          description: Indicates operation failed
          example: false
        message:
          type: string
          description: Error message describing what went wrong

````