# 获取搜索关键词推荐/Fetch search keyword suggestions

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /api/v1/douyin/search/fetch_search_suggest:
    post:
      summary: 获取搜索关键词推荐/Fetch search keyword suggestions
      deprecated: false
      description: >-
        # [中文]

        ### 用途:

        - 获取抖音 App 中搜索关键词的联想推荐结果。

        - 根据用户输入的关键词，返回相关搜索词建议，用于提升搜索体验。


        ### 备注:

        - 通常用于实现搜索框实时推荐（如输入时下拉补全）。

        - 返回的推荐词经过抖音推荐系统内部打分排序。


        ### 参数:

        - keyword: 输入的关键词，如 "人工智能"


        ### 请求体示例：

        ```json

        payload = {
            "keyword": "人工智能"
        }

        ```


        ### 返回（部分常用字段，实际返回字段更多，一切以实际响应为准）:

        - `status_code`: 状态码（0 表示成功）

        - `status_msg`: 返回信息（一般为空）

        - `rid`: 请求ID

        - `sug_list[]`: 搜索建议列表
          - `content`: 推荐的搜索关键词（如 "人工智能ai软件免费版下载"）
          - `sug_type`: 建议类型（一般为空，预留字段）
          - `pos[]`: 匹配位置（标记关键词在原搜索词中的起止位置）
            - `begin`: 开始字符位置
            - `end`: 结束字符位置
          - `word_record`:
            - `group_id`: 推荐词组ID
            - `words_position`: 在本次推荐列表中的位置
            - `words_content`: 词内容（同 `content`）
            - `words_source`: 词来源（通常为 "sug"）
          - `extra_info`:
            - `client_server_extra`: 附加配置信息（JSON字符串）
            - `poi_id`: 关联POI ID（通常为空）
            - `search_params`: 搜索参数（带内部推荐得分）
        - `words_query_record`:
          - `info`: 附加信息（通常为空）
          - `words_source`: 推荐来源
          - `query_id`: 推荐查询ID
        - `extra`:
          - `now`: 当前服务器时间戳（毫秒）
          - `logid`: 日志ID
          - `fatal_item_ids`: 错误项列表（通常为空）
          - `search_request_id`: 搜索请求ID（通常为空）
        - `log_pb`:
          - `impr_id`: 曝光日志ID
        - `time_cost`:
          - `stream_inner`: 内部处理耗时（毫秒）
          - `server_engine_cost`: 搜索引擎处理耗时（毫秒）
        - `cache_conf`:
          - `enable`: 是否命中缓存（布尔值）

        # [English]

        ### 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:

        ```json

        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)
      operationId: fetch_search_suggest_api_v1_douyin_search_fetch_search_suggest_post
      tags:
        - Douyin-Search-API
        - Douyin-Search-API
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SearchSuggestRequest'
      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: keOEI0Is7PW3lcKEyps_V
                schemeIds:
                  - HTTPBearer
            required: true
            use:
              id: keOEI0Is7PW3lcKEyps_V
            scopes:
              keOEI0Is7PW3lcKEyps_V:
                HTTPBearer: []
      x-apifox-folder: Douyin-Search-API
      x-apifox-status: released
      x-run-in-apifox: https://app.apifox.com/web/project/4705614/apis/api-370212778-run
components:
  schemas:
    SearchSuggestRequest:
      properties:
        keyword:
          type: string
          title: Keyword
          description: 需要联想的关键词/The keyword to be suggested
          default: 人工智能
      type: object
      title: SearchSuggestRequest
      x-apifox-orders:
        - keyword
      x-apifox-ignore-properties: []
      x-apifox-folder: ''
    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: []

```