Douyin modelsapi generation api

douyin/search/search-suggest

Fetch keyword suggestion results from Douyin App. Based on the user's input, returns a list of recommended search keywords to improve search experience.

Input
Idle

Example output — click Run to generate your own

API README

Fetch search keyword suggestions

Purpose:

  • Fetch keyword suggestion results from Douyin App.
  • Based on the user's input, returns a list of recommended search keywords to improve search experience.

Notes:

  • Typically used for real-time keyword suggestions in the search box.
  • The returned suggestions are scored and sorted internally by Douyin's recommendation system.

Parameters:

  • keyword: Input keyword, e.g., "Artificial Intelligence"

Request Body Example:

payload = {
    "keyword": "Artificial Intelligence"
}

Response (common fields, actual response may contain more fields):

  • status_code: Status code (0 means success)
  • status_msg: Response message (usually empty)
  • rid: Request ID
  • sug_list[]: List of suggested search keywords
    • content: Suggested keyword (e.g., "AI software free download")
    • sug_type: Suggestion type (usually empty, reserved field)
    • pos[]: Position marking
      • begin: Begin character position
      • end: End character position
    • word_record:
      • group_id: Suggestion group ID
      • words_position: Position in the current suggestion list
      • words_content: The word content (same as content)
      • words_source: Word source (typically "sug")
    • extra_info:
      • client_server_extra: Extra client-server config (JSON string)
      • poi_id: Related POI ID (usually empty)
      • search_params: Search parameters (with recommendation scores)
  • words_query_record:
    • info: Additional info (usually empty)
    • words_source: Source of suggestions
    • query_id: Suggestion query ID
  • extra:
    • now: Current server timestamp (milliseconds)
    • logid: Log ID
    • fatal_item_ids: List of fatal error items (usually empty)
    • search_request_id: Search request ID (usually empty)
  • log_pb:
    • impr_id: Impression log ID
  • time_cost:
    • stream_inner: Internal stream processing time (milliseconds)
    • server_engine_cost: Server search engine processing time (milliseconds)
  • cache_conf:
    • enable: Whether cache was hit (boolean)

Imported from a validated TikHub OpenAPI document. Pricing must be reviewed before enabling.

Related Models

douyin/search/challenge-search-v1Fetch hashtag/challenge search results from Douyin App. Returns related hashtag topics including name, view count, participants, and cover images.douyin/search/challenge-search-v2Fetch hashtag/challenge search results from Douyin App using V2 API. Supports searching by keyword and returns detailed challenge information, including name, cover image, view count, and participant count.douyin/search/challenge-suggestFetch hashtag/challenge suggestions from Douyin App based on the input keyword. Returns a list of related hashtags including name and view count.douyin/search/discuss-searchFetch discussion/Q&A search results from Douyin App. Supports filtering by keyword, sort type, publish time, content type, etc.douyin/search/experience-searchFetch experience (knowledge/tutorial) content search results from Douyin App. Retrieves video results related to knowledge sharing, tutorials, or tips based on the input keyword.douyin/search/general-search-v1Fetch search results from Douyin App's general search tab (not standalone video search). Supports filtering by keyword, sort type, publish time, video duration, and content type. Supports pagination through `cursor`, `search_id`, and `backtrace`.douyin/search/general-search-v2Fetch search results from Douyin App's general search tab (not standalone video search). This API may be less stable than V1, serving as a backup. Supports filtering by keyword, sort type, publish time, video duration, and content type. Supports pagination through `cursor`, `search_id`, and `backtrace`.douyin/search/image-searchFetch image-based search results from Douyin App. Mainly returns posts containing image collections.