/v1/tiktok/search/keyword

GET

Search by Keyword

Search TikTok videos by keyword. TikTok may return duplicate results.

Credit cost	Default: 1 credit How charges are determined Cost is decided per call, not per endpoint: the same operation can cost different amounts depending on what it returns. A call that fails costs 0 credits. A result served from cache costs 0 credits. `default` is the cost when no rule matches. Rules are evaluated in order and the first whose conditions all hold wins. A `when` condition is one of: `param` (the request parameter is true), `outcome` (the classifier's outcome), `empty` / `nonEmpty` (a response field is empty and absent, or a non-empty array or string), `flag` (a response field is exactly true). A cost of `{ perStartedMinute: n, of: [fields] }` is n x max(1, ceil(seconds / 60)), so even a short result bills at least one minute.
Cache support	Not specified in the published contract.
Pagination	No explicit pagination metadata in the published contract. Consult the parameters and response fields below.

Parameters

Name	Location / required	Schema
`query` Keyword to search for	query / required	`string`
`date_posted` Time Frame	query / optional	`string` Allowed values `["yesterday","this-week","this-month","last-3-months","last-6-months","all-time"]`
`sort_by` Sort by	query / optional	`string` Allowed values `["relevance","most-liked","date-posted"]`
`region` Two-letter proxy country code, such as US, GB, or FR. May help access country-restricted posts; does not filter posts by origin.	query / optional	`string`
`trim` Set to true to get a trimmed response	query / optional	`boolean`
`cursor` Cursor to get more videos. Get 'cursor' from previous response.	query / optional	`number`

Request examples

Replace placeholder values and supply your own API key. For operations with a request body, populate the body using the schema above.

cURL

curl --request GET 'https://api.fetchproof.com/v1/tiktok/search/keyword?query=YOUR_QUERY' \
  --header 'x-api-key: YOUR_API_KEY'

JavaScript

const response = await fetch("https://api.fetchproof.com/v1/tiktok/search/keyword?query=YOUR_QUERY", {
  method: 'GET',
  headers: { 'x-api-key': process.env.FETCHPROOF_API_KEY }
});
console.log(await response.text());

Python

import os
import requests

response = requests.get("https://api.fetchproof.com/v1/tiktok/search/keyword?query=YOUR_QUERY",
    headers={"x-api-key": os.environ["FETCHPROOF_API_KEY"]})
print(response.text)

Responses

200Success. Envelope: success / credits_remaining / credits_charged.

application/json

object

successrequired

boolean

credits_remainingrequired

integer

credits_chargedrequired

integer

cursorrequired

integer

search_item_listrequired

array

Array items

object

aweme_infooptional

object

added_sound_music_inforequired

object

albumrequired

string

allow_offline_music_to_detail_pagerequired

boolean

artistsrequired

array

Array items

object

avatarrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

enter_typerequired

integer

follow_statusrequired

integer

follower_statusrequired

integer

handlerequired

string

is_blockrequired

boolean

is_blockedrequired

boolean

is_private_accountrequired

boolean

is_verifiedrequired

boolean

is_visiblerequired

boolean

nick_namerequired

string

sec_uidrequired

string

statusrequired

integer

uidrequired

string

audition_durationrequired

integer

authorrequired

string

author_deletedrequired

boolean

author_positionrequired

null

avatar_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_thumbrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

binded_challenge_idrequired

integer

can_be_stitchedrequired

boolean

can_not_reuserequired

boolean

collect_statrequired

integer

commercial_right_typerequired

integer

cover_largerequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

cover_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

cover_thumbrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

create_timerequired

integer

dmv_auto_showrequired

boolean

durationrequired

integer

duration_high_precisionrequired

object

audition_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

number

anyOf

integer

duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

number

anyOf

integer

shoot_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

number

anyOf

integer

video_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

number

anyOf

integer

external_song_inforequired

array

extrarequired

string

has_commerce_rightrequired

boolean

idrequired

integer

id_strrequired

string

is_audio_url_with_cookierequired

boolean

is_author_artistrequired

boolean

is_commerce_musicrequired

boolean

is_matched_metadatarequired

boolean

is_originalrequired

boolean

is_original_soundrequired

boolean

is_pgcrequired

boolean

is_play_musicrequired

boolean

is_shooting_allowrequired

boolean

languageoptional

string

log_extrarequired

string

lyric_short_positionrequired

null

matched_songoptional

object

authorrequired

string

chorus_inforequired

object

duration_msrequired

integer

start_msrequired

integer

cover_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

full_durationrequired

integer

h5_urlrequired

string

idrequired

string

performersrequired

null

titlerequired

string

chorusesoptional

null

versesoptional

null

meme_song_inforequired

object

midrequired

string

multi_bit_rate_play_inforequired

null

music_release_infooptional

object

group_release_daterequired

integer

is_new_release_songrequired

boolean

mute_sharerequired

boolean

offline_descrequired

string

owner_handlerequired

string

owner_nicknamerequired

string

play_urlrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

url_keyoptional

string

positionrequired

null

prevent_downloadrequired

boolean

preview_end_timerequired

integer

preview_start_timerequired

integer

recommend_statusrequired

integer

search_highlightrequired

null

shoot_durationrequired

integer

source_platformrequired

integer

statusrequired

integer

strong_beat_urloptional

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

style_valueoptional

array

Array items

integer

tag_listrequired

null

theme_valueoptional

array

Array items

integer

titlerequired

string

tt_to_dsp_song_infosrequired

null

uncert_artistsrequired

null

user_countrequired

integer

video_durationrequired

integer

has_commerce_right_strictoptional

boolean

has_human_voiceoptional

boolean

is_commerce_music_strictoptional

boolean

music_group_use_countoptional

integer

music_ugid_use_countoptional

integer

owner_idoptional

string

sec_uidoptional

string

tag_list_v2optional

null

music_ugidoptional

integer

music_group_v3_idsoptional

array

Array items

integer

same_group_id_v3optional

integer

sim_group_id_v3optional

integer

aigc_inforequired

object

aigc_label_typerequired

integer

created_by_airequired

boolean

anchorsrequired

array

Array items

object

actionsrequired

array

anchor_strongrequired

null

component_keyrequired

string

descriptionrequired

string

extrarequired

string

general_typerequired

integer

iconrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

idrequired

string

keywordrequired

string

log_extrarequired

string

schemarequired

string

thumbnailrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

typerequired

integer

anchors_extrasrequired

string

animated_image_inforequired

object

effectrequired

integer

typerequired

integer

authorrequired

object

accept_private_policyrequired

boolean

account_labelsrequired

null

ad_cover_urlrequired

null

advance_feature_item_orderrequired

null

advanced_feature_inforequired

null

authority_statusrequired

integer

avatar_168x168required

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_300x300required

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_largerrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_thumbrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_urirequired

string

aweme_countrequired

integer

bold_fieldsrequired

null

can_message_follow_status_listrequired

array

Array items

integer

can_set_geofencingrequired

null

cha_listrequired

null

comment_filter_statusrequired

integer

comment_settingrequired

integer

commerce_user_levelrequired

integer

cover_urlrequired

null

custom_verifyrequired

string

cv_levelrequired

string

download_prompt_tsrequired

integer

enabled_filter_all_commentsrequired

boolean

enterprise_verify_reasonrequired

string

eventsrequired

null

fake_data_inforequired

object

fb_expire_timerequired

integer

follow_statusrequired

integer

follower_countrequired

integer

follower_statusrequired

integer

followers_detailrequired

null

following_countrequired

integer

friends_statusrequired

integer

geofencingrequired

null

hide_searchrequired

boolean

homepage_bottom_toastrequired

null

ins_idrequired

string

is_ad_fakerequired

boolean

is_blockrequired

boolean

is_discipline_memberrequired

boolean

is_muterequired

integer

is_mute_livesrequired

integer

is_mute_non_story_postrequired

integer

is_mute_storyrequired

integer

is_starrequired

boolean

item_listrequired

null

live_agreementrequired

integer

live_commercerequired

boolean

live_verifyrequired

integer

mention_statusrequired

integer

mutual_relation_avatarsrequired

null

name_fieldrequired

string

need_pointsrequired

null

need_recommendrequired

integer

nicknamerequired

string

platform_sync_inforequired

null

prevent_downloadrequired

boolean

relative_usersrequired

null

reply_with_video_flagrequired

integer

room_idrequired

integer

search_highlightrequired

null

search_user_descrequired

string

search_user_namerequired

string

sec_uidrequired

string

secretrequired

integer

shield_comment_noticerequired

integer

shield_digg_noticerequired

integer

shield_edit_field_inforequired

null

shield_follow_noticerequired

integer

short_idrequired

string

show_image_bubblerequired

boolean

special_accountrequired

object

special_account_listrequired

null

special_lockrequired

integer

statusrequired

integer

stitch_settingrequired

integer

story_statusrequired

integer

total_favoritedrequired

integer

type_labelrequired

null

uidrequired

string

unique_idrequired

string

user_canceledrequired

boolean

user_moderequired

integer

user_now_pack_inforequired

object

user_periodrequired

integer

user_profile_guiderequired

null

user_raterequired

integer

user_spark_inforequired

object

user_tagsrequired

null

verification_typerequired

integer

verify_inforequired

string

video_iconrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

url_prefixrequired

null

widthrequired

integer

white_cover_urlrequired

null

with_commerce_entryrequired

boolean

with_shop_entryrequired

boolean

is_mute_thoughtoptional

integer

author_user_idrequired

integer

aweme_aclrequired

object

download_generalrequired

object

coderequired

integer

muterequired

boolean

show_typerequired

integer

transcoderequired

integer

extraoptional

string

download_mask_panelrequired

object

coderequired

integer

muterequired

boolean

show_typerequired

integer

transcoderequired

integer

extraoptional

string

platform_listrequired

null

press_action_listrequired

null

share_action_listrequired

null

share_generalrequired

object

coderequired

integer

muterequired

boolean

show_typerequired

integer

transcoderequired

integer

extraoptional

string

toast_msgoptional

string

share_list_statusrequired

integer

aweme_idrequired

string

aweme_typerequired

integer

bannersrequired

array

Array items

object

keyrequired

object

component_keyrequired

string

behind_the_song_music_idsrequired

null

behind_the_song_video_music_idsrequired

null

bodydance_scorerequired

integer

branded_content_accountsrequired

null

cc_template_inforequired

object

author_namerequired

string

clip_countrequired

integer

descrequired

string

duration_millisecondsrequired

integer

related_music_idrequired

string

template_idrequired

string

cha_listrequired

array

Array items

object

authorrequired

object

account_labelsrequired

null

ad_cover_urlrequired

null

advance_feature_item_orderrequired

null

advanced_feature_inforequired

null

bold_fieldsrequired

null

can_message_follow_status_listrequired

null

can_set_geofencingrequired

null

cha_listrequired

null

cover_urlrequired

null

eventsrequired

null

followers_detailrequired

null

geofencingrequired

null

homepage_bottom_toastrequired

null

item_listrequired

null

mutual_relation_avatarsrequired

null

need_pointsrequired

null

platform_sync_inforequired

null

relative_usersrequired

null

search_highlightrequired

null

shield_edit_field_inforequired

null

type_labelrequired

null

user_profile_guiderequired

null

user_tagsrequired

null

white_cover_urlrequired

null

banner_listrequired

null

cha_attrsrequired

null

cha_namerequired

string

cidrequired

string

collect_statrequired

integer

connect_musicrequired

array

descrequired

string

extra_attrrequired

object

is_liverequired

boolean

hashtag_profilerequired

string

is_challengerequired

integer

is_commercerequired

boolean

is_pgcshowrequired

boolean

schemarequired

string

search_highlightrequired

null

share_inforequired

object

bool_persistrequired

integer

now_invitation_card_image_urlsrequired

null

share_descrequired

string

share_desc_inforequired

string

share_quoterequired

string

share_signature_descrequired

string

share_signature_urlrequired

string

share_titlerequired

string

share_title_myselfrequired

string

share_title_otherrequired

string

share_urlrequired

string

show_itemsrequired

null

sub_typerequired

integer

typerequired

integer

use_countrequired

integer

user_countrequired

integer

view_countrequired

integer

challenge_positionrequired

null

cmt_swtrequired

boolean

collect_statrequired

integer

comment_configrequired

object

comment_panel_show_tab_configrequired

object

comment_tab_info_configrequired

array

Array items

object

priorityrequired

integer

tab_idrequired

integer

tab_namerequired

string

max_tab_countrequired

integer

emoji_recommend_listrequired

array

Array items

object

emojirequired

string

emoji_idrequired

string

emoji_id_scorerequired

integer

scorerequired

integer

long_press_recommend_listrequired

null

preloadrequired

object

predsrequired

string

typeoptional

integer

quick_commentrequired

object

enabledrequired

boolean

rec_leveloptional

integer

quick_comment_emoji_recommend_listrequired

null

has_visual_commentoptional

boolean

social_quick_commentoptional

object

enabledrequired

boolean

rec_metricsrequired

object

non_social_enabledrequired

string

p_commentrequired

string

p_skiprequired

string

p_stay_timerequired

string

zero_comment_button_configoptional

object

background_urlrequired

object

url_listrequired

array

Array items

string

url_prefixrequired

null

background_url_for_blackrequired

object

url_listrequired

array

Array items

string

url_prefixrequired

null

image_typerequired

integer

zero_comment_button_enablerequired

boolean

zero_comment_button_main_textrequired

string

zero_comment_button_textrequired

string

comment_top_bar_componentoptional

array

Array items

object

actionrequired

object

click_hot_area_typerequired

integer

schemarequired

string

biz_idrequired

string

biz_typerequired

integer

desc_prefixrequired

object

contentrequired

string

desc_suffixrequired

object

contentrequired

string

extrarequired

string

namerequired

string

tail_iconrequired

object

is_localrequired

boolean

local_typerequired

integer

template_typerequired

integer

tracer_inforequired

string

comment_topbar_inforequired

null

commerce_config_datarequired

null

commerce_inforequired

object

adv_promotablerequired

boolean

auction_ad_invitedrequired

boolean

branded_content_typerequired

integer

with_comment_filter_wordsrequired

boolean

is_diversion_adoptional

integer

organic_log_extraoptional

string

content_descrequired

string

content_desc_extrarequired

array

Array items

object

endrequired

integer

hashtag_idrequired

string

hashtag_namerequired

string

is_commercerequired

boolean

line_idxrequired

integer

startrequired

integer

tag_idrequired

string

typerequired

integer

content_modelrequired

object

custom_bizrequired

object

aweme_tracerequired

string

high_quality_boost_infooptional

object

descriptionrequired

string

is_high_quality_postrequired

boolean

linkrequired

string

high_quality_boost_info_v2optional

object

standard_bizrequired

object

e_commercerequired

object

ttec_content_tagrequired

object

recommendation_tag_consumer_strrequired

string

recommendation_tag_creator_strrequired

string

tts_voice_infooptional

object

tts_voice_attrrequired

string

tts_voice_reuse_paramsrequired

string

vc_filter_infooptional

object

vc_filter_attrrequired

string

ai_comment_photooptional

object

enable_commentrequired

boolean

interactionoptional

object

collectrequired

object

creation_ideas_inforequired

object

eligiblerequired

boolean

local_alliance_infooptional

object

alliance_item_label_textrequired

string

alliance_item_label_typerequired

integer

penalty_contextoptional

object

arb_content_safety_statusrequired

integer

aweme_typerequired

integer

conclu_calculated_timerequired

integer

conclu_lifecycle_reasonrequired

integer

conclu_lifecycle_statusrequired

integer

conclu_refine_reasonrequired

integer

display_penalty_typerequired

integer

display_policyrequired

integer

display_ui_typerequired

integer

ec_global_verdictrequired

integer

is_visitor_ownerrequired

boolean

reviewedrequired

integer

statusrequired

integer

tns_statusrequired

integer

video_statusrequired

integer

baseoptional

object

statusrequired

object

rate_inforequired

object

minor_riskrequired

object

p0required

integer

p1required

integer

p2required

integer

content_original_typerequired

integer

content_size_typeoptional

integer

content_typeoptional

string

cover_labelsrequired

null

create_timerequired

integer

creation_inforequired

object

creation_used_functionsrequired

array

Array items

string

descrequired

string

desc_languagerequired

string

disable_search_trending_barrequired

boolean

distancerequired

string

distribute_typerequired

integer

follow_up_item_id_groupsrequired

string

follow_up_publish_from_idrequired

integer

geofencingrequired

null

geofencing_regionsrequired

null

green_screen_materialsrequired

null

group_idrequired

string

group_id_listrequired

object

GroupdIdList0required

array

Array items

integer

GroupdIdList1required

array

Array items

integer

has_danmakurequired

boolean

has_promote_entryrequired

integer

has_vs_entryrequired

boolean

have_dashboardrequired

boolean

hybrid_labelrequired

null

image_infosrequired

null

interact_permissionrequired

object

allow_adding_as_postrequired

object

statusrequired

integer

allow_adding_to_storyrequired

integer

allow_create_stickerrequired

object

statusrequired

integer

allow_story_switch_to_postrequired

object

statusoptional

integer

duetrequired

integer

duet_privacy_settingrequired

integer

stitchrequired

integer

stitch_privacy_settingrequired

integer

upvoterequired

integer

interaction_stickersrequired

array

Array items

object

attrrequired

string

indexrequired

integer

is_non_globalrequired

boolean

is_non_global_v2required

boolean

material_indexrequired

integer

text_inforequired

string

track_inforequired

string

typerequired

integer

is_adsrequired

boolean

is_description_translatablerequired

boolean

is_hash_tagrequired

integer

is_nff_or_nrrequired

boolean

is_on_this_dayrequired

integer

is_pgcshowrequired

boolean

is_previewrequired

integer

is_relieverequired

boolean

is_text_sticker_translatablerequired

boolean

is_title_translatablerequired

boolean

is_toprequired

integer

is_vrrequired

boolean

item_comment_settingsrequired

integer

item_duetrequired

integer

item_reactrequired

integer

item_stitchrequired

integer

label_toprequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

label_top_textrequired

null

long_videorequired

null

main_arch_commonrequired

string

mask_infosrequired

array

misc_inforequired

string

muf_comment_info_v2required

null

musicrequired

object

albumrequired

string

allow_offline_music_to_detail_pagerequired

boolean

artistsrequired

array

Array items

object

avatarrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

enter_typerequired

integer

follow_statusrequired

integer

follower_statusrequired

integer

handlerequired

string

is_blockrequired

boolean

is_blockedrequired

boolean

is_private_accountrequired

boolean

is_verifiedrequired

boolean

is_visiblerequired

boolean

nick_namerequired

string

sec_uidrequired

string

statusrequired

integer

uidrequired

string

audition_durationrequired

integer

authorrequired

string

author_deletedrequired

boolean

author_positionrequired

null

avatar_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

avatar_thumbrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

binded_challenge_idrequired

integer

can_be_stitchedrequired

boolean

can_not_reuserequired

boolean

collect_statrequired

integer

commercial_right_typerequired

integer

cover_largerequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

cover_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

cover_thumbrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

create_timerequired

integer

dmv_auto_showrequired

boolean

durationrequired

integer

duration_high_precisionrequired

object

audition_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

number

anyOf

integer

duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

number

anyOf

integer

shoot_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

number

anyOf

integer

video_duration_precisionrequired

schema

anyOf

integer

anyOf

schema

anyOf

number

anyOf

integer

external_song_inforequired

array

extrarequired

string

has_commerce_rightrequired

boolean

idrequired

integer

id_strrequired

string

is_audio_url_with_cookierequired

boolean

is_author_artistrequired

boolean

is_commerce_musicrequired

boolean

is_matched_metadatarequired

boolean

is_originalrequired

boolean

is_original_soundrequired

boolean

is_pgcrequired

boolean

is_play_musicrequired

boolean

is_shooting_allowrequired

boolean

languageoptional

string

log_extrarequired

string

lyric_short_positionrequired

null

matched_songoptional

object

authorrequired

string

chorus_inforequired

object

duration_msrequired

integer

start_msrequired

integer

cover_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

full_durationrequired

integer

h5_urlrequired

string

idrequired

string

performersrequired

null

titlerequired

string

chorusesoptional

null

versesoptional

null

meme_song_inforequired

object

midrequired

string

multi_bit_rate_play_inforequired

null

music_release_infooptional

object

group_release_daterequired

integer

is_new_release_songrequired

boolean

mute_sharerequired

boolean

offline_descrequired

string

owner_handlerequired

string

owner_nicknamerequired

string

play_urlrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

url_keyoptional

string

positionrequired

null

prevent_downloadrequired

boolean

preview_end_timerequired

integer

preview_start_timerequired

integer

recommend_statusrequired

integer

search_highlightrequired

null

shoot_durationrequired

integer

source_platformrequired

integer

statusrequired

integer

strong_beat_urloptional

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

style_valueoptional

array

Array items

integer

tag_listrequired

null

theme_valueoptional

array

Array items

integer

titlerequired

string

tt_to_dsp_song_infosrequired

null

uncert_artistsrequired

null

user_countrequired

integer

video_durationrequired

integer

has_commerce_right_strictoptional

boolean

has_human_voiceoptional

boolean

is_commerce_music_strictoptional

boolean

music_group_use_countoptional

integer

music_ugid_use_countoptional

integer

mute_typeoptional

integer

owner_idoptional

string

sec_uidoptional

string

tag_list_v2optional

null

music_ugidoptional

integer

music_group_v3_idsoptional

array

Array items

integer

same_group_id_v3optional

integer

sim_group_id_v3optional

integer

music_begin_time_in_msrequired

integer

music_end_time_in_msoptional

integer

music_selected_fromrequired

string

music_title_stylerequired

integer

music_volumerequired

string

need_trim_steprequired

boolean

need_vs_entryrequired

boolean

nickname_positionrequired

null

no_selected_musicrequired

boolean

operator_boost_inforequired

null

origin_comment_idsrequired

null

origin_volumerequired

string

original_client_textrequired

object

markup_textrequired

string

text_extrarequired

array

Array items

object

hashtag_idrequired

string

hashtag_namerequired

string

is_commercerequired

boolean

sec_uidoptional

string

tag_idrequired

string

typerequired

integer

user_idoptional

string

picked_usersrequired

array

playlist_blockedrequired

boolean

poi_dataoptional

object

address_inforequired

object

addressrequired

string

city_coderequired

string

city_namerequired

string

geohashrequired

string

l0_geoname_idrequired

string

latrequired

string

lngrequired

string

region_coderequired

string

collect_inforequired

string

comment_anchorrequired

object

has_sub_arrowrequired

boolean

hide_listrequired

null

sub_tag_exp_timerequired

integer

sub_tag_exp_typerequired

integer

sub_tagsrequired

array

Array items

object

namerequired

string

priorityrequired

integer

typerequired

integer

suffixrequired

string

track_inforequired

string

iconrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

info_sourcerequired

string

poi_idrequired

string

poi_mapkit_collectrequired

boolean

poi_namerequired

string

poi_review_configrequired

object

poi_typerequired

string

thumbnailrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

type_levelrequired

string

video_anchorrequired

object

has_sub_arrowrequired

boolean

hide_listrequired

null

sub_tag_exp_timerequired

integer

sub_tag_exp_typerequired

integer

sub_tagsrequired

array

Array items

object

namerequired

string

priorityrequired

integer

typerequired

integer

suffixrequired

string

track_inforequired

string

video_countrequired

integer

poi_re_tag_signalrequired

integer

positionrequired

null

prevent_downloadrequired

boolean

products_inforequired

null

promote_capcut_togglerequired

integer

promote_icon_textrequired

string

promote_toastrequired

string

promote_toast_keyrequired

string

question_listrequired

null

quick_reply_emojisrequired

array

Array items

string

raterequired

integer

reference_tts_voice_idsrequired

null

reference_voice_filter_idsrequired

null

regionrequired

string

risk_infosrequired

object

contentrequired

string

risk_sinkrequired

boolean

typerequired

integer

voterequired

boolean

warnrequired

boolean

search_descrequired

string

search_highlightrequired

array

Array items

object

fieldrequired

string

positionsrequired

array

Array items

object

beginrequired

integer

endrequired

integer

share_inforequired

object

bool_persistrequired

integer

now_invitation_card_image_urlsrequired

null

share_descrequired

string

share_desc_inforequired

string

share_link_descrequired

string

share_quoterequired

string

share_signature_descrequired

string

share_signature_urlrequired

string

share_titlerequired

string

share_title_myselfrequired

string

share_title_otherrequired

string

share_urlrequired

string

whatsapp_descrequired

string

share_urlrequired

string

shoot_tab_nameoptional

string

social_interaction_blobrequired

object

auxiliary_model_contentrequired

string

solaria_profilerequired

object

profilerequired

string

sort_labelrequired

string

standard_component_infooptional

object

banner_enabledrequired

boolean

statisticsrequired

object

aweme_idrequired

string

collect_countrequired

integer

comment_countrequired

integer

digg_countrequired

integer

download_countrequired

integer

forward_countrequired

integer

lose_comment_countrequired

integer

lose_countrequired

integer

play_countrequired

integer

repost_countrequired

integer

share_countrequired

integer

whatsapp_share_countrequired

integer

statusrequired

object

allow_commentrequired

boolean

allow_sharerequired

boolean

aweme_idrequired

string

download_statusrequired

integer

in_reviewingrequired

boolean

is_deleterequired

boolean

is_prohibitedrequired

boolean

private_statusrequired

integer

review_resultrequired

object

review_statusrequired

integer

reviewedrequired

integer

self_seerequired

boolean

violation_display_statusoptional

integer

suggest_wordsoptional

object

suggest_wordsrequired

array

Array items

object

hint_textrequired

string

qrec_virtual_enablerequired

string

scenerequired

string

wordsrequired

array

Array items

object

penetrate_inforequired

string

wordrequired

string

word_idrequired

string

word_recordrequired

object

words_langrequired

string

is_personalizedoptional

boolean

qrec_json_infooptional

string

words_labeloptional

string

rich_sug_infooptional

object

sug_icon_typerequired

string

sug_icon_urirequired

string

sug_reasonrequired

string

sug_reason_typerequired

string

feed_query_enable_videosugoptional

boolean

support_danmakurequired

boolean

text_extrarequired

array

Array items

object

endrequired

integer

hashtag_idrequired

string

hashtag_namerequired

string

is_commercerequired

boolean

sec_uidoptional

string

startrequired

integer

typerequired

integer

user_idoptional

string

tag_idoptional

string

text_sticker_major_langrequired

string

title_languagerequired

string

ttec_suggest_wordsrequired

object

ttec_suggest_wordsrequired

null

tts_voice_idsrequired

null

ttt_product_recall_typeoptional

integer

uniqid_positionrequired

null

upvote_inforequired

object

friends_recall_inforequired

string

repost_initiate_scorerequired

integer

user_upvotedrequired

boolean

upvote_preloadrequired

object

need_pull_upvote_inforequired

boolean

used_full_songrequired

boolean

user_diggedrequired

integer

videorequired

object

CoverTsprequired

schema

anyOf

integer

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

number

anyOf

integer

anyOf

integer

anyOf

integer

ai_dynamic_coverrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

ai_dynamic_cover_bakrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

animated_coverrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

big_thumbsrequired

array

Array items

object

durationrequired

number

fextrequired

string

img_numrequired

integer

img_urisrequired

array

Array items

string

img_urlrequired

string

img_urlsrequired

array

Array items

string

img_x_lenrequired

integer

img_x_sizerequired

integer

img_y_lenrequired

integer

img_y_sizerequired

integer

intervalrequired

integer

urirequired

string

bit_raterequired

array

Array items

object

HDR_bitrequired

string

HDR_typerequired

string

bit_raterequired

integer

dub_infosrequired

null

fpsrequired

integer

gear_namerequired

string

is_bytevc1required

integer

play_addrrequired

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

quality_typerequired

integer

video_extrarequired

string

fid_profile_labelsoptional

string

bit_rate_audiorequired

array

cdn_url_expiredrequired

integer

cla_inforequired

object

caption_infosrequired

array

Array items

object

caption_formatrequired

string

caption_lengthrequired

integer

cla_subtitle_idrequired

integer

complaint_idrequired

integer

expirerequired

integer

is_auto_generatedrequired

boolean

is_original_captionrequired

boolean

langrequired

string

language_coderequired

string

language_idrequired

integer

source_tagrequired

string

sub_idrequired

integer

sub_versionrequired

string

subtitle_typerequired

integer

translation_typerequired

integer

translator_idrequired

integer

urlrequired

string

url_listrequired

array

Array items

string

variantrequired

string

captions_typerequired

integer

creator_edited_caption_idrequired

integer

enable_auto_captionrequired

integer

has_original_audiorequired

integer

hide_original_captionrequired

boolean

no_caption_reasonrequired

integer

original_language_infooptional

object

can_translate_realtimerequired

boolean

can_translate_realtime_skip_translation_lang_checkrequired

boolean

first_subtitle_timerequired

integer

is_burnin_captionrequired

boolean

langrequired

string

language_coderequired

string

language_idrequired

integer

original_caption_typerequired

integer

vertical_positionsrequired

null

is_author_dubbing_qualifiedoptional

boolean

no_caption_reason_v2optional

integer

show_asr_edit_guide_banneroptional

boolean

coverrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

download_addroptional

object

data_sizerequired

integer

file_csrequired

string

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

download_no_watermark_addroptional

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

durationrequired

integer

dynamic_coverrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

has_watermarkrequired

boolean

heightrequired

integer

is_bytevc1required

integer

is_callbackrequired

boolean

is_long_videooptional

integer

metarequired

string

need_set_tokenrequired

boolean

origin_coverrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

data_sizeoptional

integer

play_addrrequired

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

play_addr_bytevc1required

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

play_addr_h264required

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

ratiorequired

string

source_HDR_typerequired

integer

tagsrequired

null

video_modeloptional

string

widthrequired

integer

cover_is_customoptional

boolean

cover_rgboptional

string

did_profile_labelsoptional

string

misc_download_addrsoptional

string

vid_profile_labelsoptional

string

tagoptional

object

background_colorrequired

string

en_titlerequired

string

font_colorrequired

string

opacityrequired

integer

titlerequired

string

typerequired

string

video_controlrequired

object

allow_downloadrequired

boolean

allow_duetrequired

boolean

allow_dynamic_wallpaperrequired

boolean

allow_musicrequired

boolean

allow_reactrequired

boolean

allow_stitchrequired

boolean

draft_progress_barrequired

integer

prevent_download_typerequired

integer

share_typerequired

integer

show_progress_barrequired

integer

timer_statusrequired

integer

video_labelsrequired

array

video_textrequired

array

visual_search_inforequired

object

api_control_infooptional

string

author_visual_search_enableoptional

integer

ecom_nocart_entrance_enable_typeoptional

integer

enable_pre_upload_image_typeoptional

integer

fallback_vtag_enableoptional

boolean

fallback_vtag_enable_typeoptional

integer

fallback_vtag_infooptional

object

intentoptional

integer

long_press_entrance_enableoptional

boolean

long_press_entrance_enable_typeoptional

integer

screenshot_entrance_enableoptional

integer

visual_search_intent_leveloptional

integer

visual_search_recordoptional

object

intent_v1_categoryrequired

integer

item_extra_flagsrequired

string

vtag_enableoptional

boolean

vtag_enable_typeoptional

integer

voice_filter_idsrequired

null

with_promotional_musicrequired

boolean

without_watermarkrequired

boolean

is_adrequired

boolean

is_eligible_for_commissionrequired

boolean

is_paid_partnershiprequired

boolean

create_time_utcrequired

string

{
  "format": "date-time"
}

urlrequired

string

shop_product_urlrequired

string

ai_remix_infooptional

object

has_entrancerequired

boolean

allow_giftoptional

boolean

batch_indexoptional

integer

bottom_productsoptional

null

c2pa_infooptional

object

aigc_srcrequired

string

c2pa_extra_datarequired

string

dedup_errrequired

string

dedup_srcrequired

string

first_aigc_srcoptional

string

first_srcoptional

string

is_capcutrequired

boolean

is_tiktokrequired

boolean

last_aigc_srcoptional

string

last_srcoptional

string

total_audiorequired

integer

total_errrequired

integer

total_imgrequired

integer

total_srcrequired

integer

total_vidrequired

integer

upload_durrequired

integer

comment_at_tako_infooptional

object

show_tako_accountrequired

integer

content_leveloptional

integer

creator_ai_commentoptional

object

eligible_videorequired

boolean

has_ai_topicrequired

boolean

not_eligible_reasonrequired

integer

ecosystem_perception_enhancementoptional

null

has_ever_advertisedoptional

boolean

is_close_friends_onlyoptional

boolean

is_paid_contentoptional

boolean

item_allow_ai_remixoptional

integer

meme_reg_infooptional

object

paid_content_infooptional

object

paid_collection_idrequired

integer

promoteoptional

object

extrarequired

string

is_show_video_viewrequired

boolean

promote_traffic_tagrequired

object

need_trackrequired

boolean

traffic_levelrequired

integer

versionrequired

string

video_view_countrequired

integer

video_view_schemarequired

string

retry_typeoptional

integer

right_productsoptional

null

smart_search_infooptional

object

ai_overview_intent_typerequired

integer

ask_tako_intent_typerequired

integer

find_similar_intent_typerequired

integer

related_videos_intent_typerequired

integer

tea_datarequired

object

s_s_has_tako_statrequired

integer

title_smart_search_panel_typerequired

integer

story_remix_infooptional

object

is_support_remixrequired

boolean

survey_infooptional

null

tako_bubble_infooptional

object

tako_bubble_enablerequired

boolean

tns_ue_feed_infooptional

object

footnoterequired

object

can_add_footnoterequired

integer

pending_countrequired

integer

search_aweme_infooptional

object

has_creation_intentionrequired

boolean

aweme_idoptional

string

descoptional

string

desc_languageoptional

string

regionoptional

string

statisticsoptional

object

aweme_idrequired

string

collect_countrequired

integer

comment_countrequired

integer

digg_countrequired

integer

download_countrequired

integer

forward_countrequired

integer

lose_comment_countrequired

integer

lose_countrequired

integer

play_countrequired

integer

repost_countrequired

integer

share_countrequired

integer

whatsapp_share_countrequired

integer

videooptional

object

CoverTsprequired

integer

ai_dynamic_coverrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

ai_dynamic_cover_bakrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

animated_coverrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

big_thumbsrequired

array

bit_raterequired

array

Array items

object

HDR_bitrequired

string

HDR_typerequired

string

bit_raterequired

integer

dub_infosrequired

null

fid_profile_labelsrequired

string

fpsrequired

integer

gear_namerequired

string

is_bytevc1required

integer

play_addrrequired

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

quality_typerequired

integer

bit_rate_audiorequired

array

cdn_url_expiredrequired

integer

cla_inforequired

object

caption_infosrequired

array

Array items

object

caption_formatrequired

string

caption_lengthrequired

integer

cla_subtitle_idrequired

integer

complaint_idrequired

integer

expirerequired

integer

is_auto_generatedrequired

boolean

is_original_captionrequired

boolean

langrequired

string

language_coderequired

string

language_idrequired

integer

source_tagrequired

string

sub_idrequired

integer

sub_versionrequired

string

subtitle_typerequired

integer

translation_typerequired

integer

translator_idrequired

integer

urlrequired

string

url_listrequired

array

Array items

string

variantrequired

string

captions_typerequired

integer

creator_edited_caption_idrequired

integer

enable_auto_captionrequired

integer

has_original_audiorequired

integer

hide_original_captionrequired

boolean

no_caption_reasonrequired

integer

original_language_inforequired

object

can_translate_realtimerequired

boolean

can_translate_realtime_skip_translation_lang_checkrequired

boolean

first_subtitle_timerequired

integer

is_burnin_captionrequired

boolean

langrequired

string

language_coderequired

string

language_idrequired

integer

original_caption_typerequired

integer

vertical_positionsrequired

null

coverrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

did_profile_labelsrequired

string

download_addrrequired

object

data_sizerequired

integer

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

download_no_watermark_addrrequired

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

durationrequired

integer

dynamic_coverrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

has_watermarkrequired

boolean

heightrequired

integer

is_bytevc1required

integer

is_callbackrequired

boolean

need_set_tokenrequired

boolean

origin_coverrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

play_addrrequired

object

data_sizerequired

integer

file_csrequired

string

file_hashrequired

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

ratiorequired

string

source_HDR_typerequired

integer

tagsrequired

null

vid_profile_labelsrequired

string

widthrequired

integer

authoroptional

object

accept_private_policyrequired

boolean

account_labelsrequired

null

ad_cover_urlrequired

null

advance_feature_item_orderrequired

null

advanced_feature_inforequired

null

authority_statusrequired

integer

avatar_168x168required

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

avatar_300x300required

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

avatar_largerrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

avatar_mediumrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

avatar_thumbrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

avatar_urirequired

string

aweme_countrequired

integer

bold_fieldsrequired

null

can_message_follow_status_listrequired

null

can_set_geofencingrequired

null

cha_listrequired

null

comment_filter_statusrequired

integer

comment_settingrequired

integer

commerce_user_levelrequired

integer

cover_urlrequired

null

custom_verifyrequired

string

cv_levelrequired

string

download_prompt_tsrequired

integer

enabled_filter_all_commentsrequired

boolean

enterprise_verify_reasonrequired

string

eventsrequired

null

fake_data_inforequired

object

fb_expire_timerequired

integer

follow_statusrequired

integer

follower_countrequired

integer

follower_statusrequired

integer

followers_detailrequired

null

following_countrequired

integer

friends_statusrequired

integer

geofencingrequired

null

hide_searchrequired

boolean

homepage_bottom_toastrequired

null

ins_idrequired

string

is_ad_fakerequired

boolean

is_blockrequired

boolean

is_discipline_memberrequired

boolean

is_muterequired

integer

is_mute_livesrequired

integer

is_mute_non_story_postrequired

integer

is_mute_storyrequired

integer

is_starrequired

boolean

item_listrequired

null

live_agreementrequired

integer

live_commercerequired

boolean

live_verifyrequired

integer

mention_statusrequired

integer

mutual_relation_avatarsrequired

null

name_fieldrequired

string

need_pointsrequired

null

need_recommendrequired

integer

nicknamerequired

string

platform_sync_inforequired

null

prevent_downloadrequired

boolean

relative_usersrequired

null

reply_with_video_flagrequired

integer

room_idrequired

integer

search_highlightrequired

null

search_user_descrequired

string

search_user_namerequired

string

sec_uidrequired

string

secretrequired

integer

shield_comment_noticerequired

integer

shield_digg_noticerequired

integer

shield_edit_field_inforequired

null

shield_follow_noticerequired

integer

short_idrequired

string

show_image_bubblerequired

boolean

special_accountrequired

object

special_account_listrequired

null

special_lockrequired

integer

statusrequired

integer

stitch_settingrequired

integer

total_favoritedrequired

integer

type_labelrequired

null

uidrequired

string

unique_idrequired

string

user_canceledrequired

boolean

user_moderequired

integer

user_periodrequired

integer

user_profile_guiderequired

null

user_raterequired

integer

user_spark_inforequired

object

user_tagsrequired

null

verification_typerequired

integer

verify_inforequired

string

video_iconrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

url_prefixrequired

null

widthrequired

integer

white_cover_urlrequired

null

with_commerce_entryrequired

boolean

with_shop_entryrequired

boolean

create_timeoptional

integer

is_adoptional

boolean

is_eligible_for_commissionoptional

boolean

create_time_utcoptional

string

{
  "format": "date-time"
}

urloptional

string

has_moreoptional

integer

401Invalid or missing x-api-key

402No credits remaining

403Upstream denied (age gate, audience controls)

404Resource or endpoint not found

429Rate limited