ae_tiktok_ads_get_recommended_ads
Find ads similar to a specified reference ad. Provide the required reference material ID in request_body.material_id. You may optionally provide industry, country_code, or cookie; industry and country_code have default values. The response includes recommended ad materials with available titles, brand names, performance and engagement metadata, classification fields, and video details such as duration, cover, dimensions, and playback URLs. Results may be limited, so adjusting or removing filters can help when no materials are returned.
ae_tiktok_analytics_detect_fake_views
Use this tool to evaluate a short-form video’s traffic quality and potential view fraud. Provide the video item ID; you may optionally select a content category to adjust engagement benchmarks. The result summarizes video metrics, engagement rates, creator and content indicators, fake-view risk scores, estimated fake and organic views, traffic-tier analysis, suspicious features, and recommended actions. A business-impact report may also be included when applicable.
ae_tiktok_check_live_room_online
检查直播间当前是否在线。
输入:
- `room_id`:必填,直播间 ID,字符串。
返回:
- 在线状态检查结果,通常位于响应的 `data` 中;同时可能包含请求状态等标准响应信息。
ae_tiktok_check_live_room_online_batch
# Purpose
Batch-check whether multiple TikTok live rooms are online, with support for up to 50 room IDs per request.
# Input
Provide a required `request_body` object containing `room_ids`, an array of TikTok live-room ID strings.
# Returns
The response data contains the online-status result for the submitted rooms, together with the service response metadata.
# 用途
批量检测多个 TikTok 直播间是否在线,每次最多支持 50 个直播间 ID。
# 输入
提供必填的 `request_body` 对象,其中包含 `room_ids` 字段;该字段是由 TikTok 直播间 ID 字符串组成的数组。
# 返回
响应数据包含所提交直播间的在线状态结果,并附带服务响应元数据。
ae_tiktok_fetch_gift_name_by_id
根据单个 TikTok Gift ID 查询对应的礼物名称。输入:request_body 中的 gift_id(字符串)。返回:响应的 data 字段包含礼物名称查询结果。 | Query the gift name for a single TikTok Gift ID. Input: gift_id (string) inside request_body. Output: the response data contains the gift-name lookup result.
ae_tiktok_fetch_gift_names_by_ids
批量查询多个礼物 ID 对应的礼物名称。输入一个或多个礼物 ID 字符串,工具将在返回数据中提供对应的查询结果。 | Batch-lookup the names associated with multiple gift IDs. Provide one or more gift ID strings; the returned data contains the corresponding lookup result.
ae_tiktok_fetch_search_photo
用于按关键词搜索照片。keyword 为必填搜索词;count 默认为 20。首次搜索可使用默认的 offset 和 search_id,继续翻页时请填写上一页响应中获得的分页值。cookie 为可选项,仅在需要时提供。返回照片搜索结果及相关响应信息。
ae_tiktok_fetch_user_like
获取用户的公开点赞视频列表。
参数:
- `secUid`:用户的 secUid,必填。
- `cursor`:分页游标,默认 `0`。
- `count`:每页数量,默认 `20`。
- `coverFormat`:封面格式,默认 `2`。
- `post_item_list_request_type`:排序方式,默认 `0`;可选值包括 `0`(默认)、`1`(热门)、`2`(最旧)。
返回:
- 请求用户点赞列表对应的响应数据。
注意:
- 仅适用于点赞列表公开的用户。
- 返回数据中的视频 CDN 直链可能需要使用响应中的 `tt_chain_token`,通过请求头 `Cookie: tt_chain_token={tt_chain_token}` 访问。
- 如果该直链仍返回 HTTP 403,请改用响应中以 `https://www.tiktok.com/aweme/v1/play/` 开头的视频链接,并且不要携带上述 Cookie。
ae_tiktok_fetch_user_mix
Retrieves the videos in a specified user mix with cursor-based pagination. Required input: `mixId`, the mix identifier. Optional inputs: `cursor` (starting pagination cursor, default `0`) and `count` (requested items per page, default `30`). The response returns the mix’s video-list data and any pagination information provided by the service.
ae_tiktok_fetch_user_play_list
Fetches a user's playlist.
Parameters:
- `secUid` (required): The user's secUid.
- `cursor` (optional, default `0`): Pagination cursor for the playlist.
- `count` (optional, default `30`): Number of items to request per page.
Returns the playlist data, which may include video URL lists, together with response and request metadata. Direct video CDN URLs may require `Cookie: tt_chain_token={tt_chain_token}`, using the token returned in the response. If a direct CDN URL returns HTTP 403, use the TikTok play URL in the video's `UrlList` without any Cookie.
ae_tiktok_fetch_user_repost
Retrieve a user's reposted works. Required input: secUid, the user's identifier. Optional inputs: cursor for the page position (default 0), count for the page size (default 20), and coverFormat for the cover format (default 2; supported values are 1 and 2). The response returns the reposted works in its data field together with response metadata. If media URLs are included, follow any access requirements associated with the returned URL or token.
ae_tiktok_get_creator_search_insights_detail
Retrieve detailed creator search insights for a specific query.
Inputs:
- `query_id_str` (required): Query ID obtained from creator search insights.
- `time_range` (optional): `past_7_days`, `past_30_days` (default), `past_60_days`, `past_6_months`, or `custom`.
- `start_date` and `end_date` (optional): Unix timestamps in seconds, used for a custom range. Provide both; the custom range cannot exceed six months.
- `dimension_list` (optional): Comma-separated dimensions: `gender`, `age`, and/or `country`.
Returns detailed search insight data, including search trends and audience demographics.
ae_tiktok_get_creator_search_insights_trend
### Purpose
Retrieve creator search trend insights for an existing query, including search popularity by region and trends over time.
### Inputs
- `query_id_str` (required): Query ID obtained from creator search insights.
- `from_tab_path` (optional): Source tab path; defaults to `TRENDING,TOPICS`.
- `query_analysis_required` (optional): Whether query analysis is required; defaults to `true`.
### Returns
Search trend data for the specified query. The response data can include regional popularity and trends over time.
ae_tiktok_get_creator_search_insights_videos
Retrieves popular videos related to a creator-search insight keyword. Enter a keyword, optionally specify the pagination offset (default 0) and number of results per page (default 20), and review the related-video results. The keyword can come from creator search insights or creator search trends.
ae_tiktok_get_hashtag_detail
Retrieves details for a specified hashtag. The hashtag ID is required. Region is optional and supports US, GB, FR, JP, VN, and SG; if omitted, it defaults to US. The response data contains the hashtag details.
ae_tiktok_get_music_chart
Retrieve TikTok music chart entries. Set `scene` to 0 for Top 50 or 1 for Viral 50. Use `cursor` to page through results (default 0) and `count` to set the page size (default 50, maximum 50). The response provides chart data, including song information and ranking changes, along with response metadata such as status and generation time.