/v3/tiktok/profile/videos

GET

Profile Videos

Get posts from a TikTok profile. Posts may be missing even after full pagination; region selection does not guarantee complete coverage.

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
`handle` TikTok handle	query / required	`string`
`user_id` TikTok user id. Use this for faster responses.	query / optional	`string`
`sort_by` What to sort by	query / optional	`string` Allowed values `["latest","popular"]`
`region` Two-letter feed country code; defaults to US. Try another relevant country if the feed is empty. Keep it unchanged while paginating; changing region does not guarantee complete coverage.	query / optional	`string`
`include_pinned` Include pinned posts; defaults to true. false excludes them, even with trim=true. Keep unchanged while paginating. Pages may be short or empty; follow has_more and max_cursor. Successful pages cost 1 credit, even if empty.	query / optional	`boolean`
`trim` Set to true for a trimmed down version of the response	query / optional	`boolean`
`max_cursor` Cursor to get more videos. Get 'max_cursor' from previous response.	query / optional	`string`

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/v3/tiktok/profile/videos?handle=YOUR_HANDLE' \
  --header 'x-api-key: YOUR_API_KEY'

JavaScript

const response = await fetch("https://api.fetchproof.com/v3/tiktok/profile/videos?handle=YOUR_HANDLE", {
  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/v3/tiktok/profile/videos?handle=YOUR_HANDLE",
    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

aweme_listrequired

array

Array items

object

added_sound_music_infooptional

object

albumrequired

string

allow_offline_music_to_detail_pagerequired

boolean

artistsrequired

array

Array items

object

uidrequired

string

sec_uidrequired

string

nick_namerequired

string

handlerequired

string

avatarrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

is_verifiedrequired

boolean

enter_typerequired

integer

follow_statusrequired

integer

is_visiblerequired

boolean

follower_statusrequired

integer

is_private_accountrequired

boolean

is_blockrequired

boolean

is_blockedrequired

boolean

statusrequired

integer

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

number

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

duration_precisionrequired

schema

anyOf

number

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

shoot_duration_precisionrequired

schema

anyOf

number

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

video_duration_precisionrequired

schema

anyOf

number

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

number

anyOf

integer

anyOf

number

anyOf

integer

anyOf

integer

anyOf

number

anyOf

number

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

log_extrarequired

string

lyric_short_positionrequired

null

meme_song_inforequired

object

midrequired

string

multi_bit_rate_play_inforequired

null

mute_sharerequired

boolean

offline_descrequired

string

owner_handlerequired

string

owner_idoptional

string

owner_nicknamerequired

string

play_urlrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

positionrequired

null

prevent_downloadrequired

boolean

preview_end_timerequired

integer

preview_start_timerequired

integer

recommend_statusrequired

integer

search_highlightrequired

null

sec_uidoptional

string

shoot_durationrequired

integer

source_platformrequired

integer

statusrequired

integer

tag_listrequired

null

titlerequired

string

tt_to_dsp_song_infosrequired

null

uncert_artistsrequired

null

user_countrequired

integer

video_durationrequired

integer

strong_beat_urloptional

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

url_prefixrequired

null

matched_pgc_soundoptional

object

authorrequired

string

titlerequired

string

mixed_titlerequired

string

mixed_authorrequired

string

music_release_inforequired

object

is_new_release_songrequired

boolean

group_release_daterequired

integer

artist_infosrequired

array

Array items

object

uidrequired

string

sec_uidrequired

string

nick_namerequired

string

handlerequired

string

avatarrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

is_verifiedrequired

boolean

enter_typerequired

integer

follow_statusrequired

integer

is_visiblerequired

boolean

follower_statusrequired

integer

is_private_accountrequired

boolean

is_blockrequired

boolean

is_blockedrequired

boolean

statusrequired

integer

uncert_artistsrequired

null

cover_mediumrequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

url_prefixrequired

null

matched_songoptional

object

idrequired

string

authorrequired

string

titlerequired

string

h5_urlrequired

string

cover_mediumrequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

url_prefixrequired

null

performersrequired

null

chorus_inforequired

object

start_msrequired

integer

duration_msrequired

integer

full_durationrequired

integer

versesrequired

null

chorusesrequired

null

style_valueoptional

array

Array items

integer

theme_valueoptional

array

Array items

integer

languageoptional

string

theme_tagsoptional

array

Array items

string

music_group_use_countoptional

integer

music_group_v3_idsoptional

array

Array items

integer

has_human_voiceoptional

boolean

same_group_id_v3optional

integer

sim_group_id_v3optional

integer

music_ugidoptional

integer

music_ugid_use_countoptional

integer

has_commerce_right_strictoptional

boolean

is_commerce_music_strictoptional

boolean

tag_list_v2optional

null

music_release_infooptional

object

is_new_release_songrequired

boolean

group_release_daterequired

integer

is_unlimited_musicoptional

boolean

lyric_scene_copyrightoptional

object

lyric_stickerrequired

boolean

lyricsoptional

array

Array items

object

lyric_idrequired

integer

lyric_typerequired

integer

aigc_infooptional

object

aigc_label_typerequired

integer

created_by_airequired

boolean

anchorsoptional

null

anchors_extrasoptional

string

animated_image_infooptional

object

effectrequired

integer

typerequired

integer

authorrequired

object

accept_private_policyrequired

boolean

account_labelsrequired

null

account_regionrequired

string

ad_cover_urlrequired

null

advance_feature_item_orderrequired

null

advanced_feature_inforequired

null

apple_accountrequired

integer

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_meta_info_listrequired

array

Array items

object

avatar_categoryrequired

integer

avatar_meta_inforequired

object

avatar_sourceoptional

integer

avatar_choiceoptional

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

bind_phonerequired

string

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

array

create_timerequired

integer

custom_verifyrequired

string

cv_levelrequired

string

download_prompt_tsrequired

integer

download_settingrequired

integer

duet_settingrequired

integer

enabled_filter_all_commentsrequired

boolean

enterprise_verify_reasonrequired

string

eventsrequired

null

fake_data_inforequired

object

favoriting_countrequired

integer

fb_expire_timerequired

integer

follow_statusrequired

integer

follower_countrequired

integer

follower_statusrequired

integer

followers_detailrequired

null

following_countrequired

integer

friends_statusrequired

integer

geofencingrequired

null

google_accountrequired

string

has_emailrequired

boolean

has_facebook_tokenrequired

boolean

has_insightsrequired

boolean

has_ordersrequired

boolean

has_twitter_tokenrequired

boolean

has_youtube_tokenrequired

boolean

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_phone_bindedrequired

boolean

is_starrequired

boolean

item_listrequired

null

languagerequired

string

live_agreementrequired

integer

live_commercerequired

boolean

live_verifyrequired

integer

mention_statusrequired

integer

mutual_relation_avatarsrequired

null

need_pointsrequired

null

need_recommendrequired

integer

nicknamerequired

string

original_musicianrequired

object

digg_countrequired

integer

music_countrequired

integer

music_used_countrequired

integer

new_release_clip_idsrequired

null

platform_sync_inforequired

null

prevent_downloadrequired

boolean

react_settingrequired

integer

regionoptional

string

relative_usersrequired

null

reply_with_video_flagrequired

integer

room_idrequired

integer

search_highlightrequired

null

sec_uidrequired

string

secretrequired

integer

share_inforequired

object

now_invitation_card_image_urlsrequired

null

share_descrequired

string

share_desc_inforequired

string

share_qrcode_urlrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

url_prefixrequired

null

widthrequired

integer

share_titlerequired

string

share_title_myselfrequired

string

share_title_otherrequired

string

share_urlrequired

string

share_qrcode_urirequired

string

shield_comment_noticerequired

integer

shield_digg_noticerequired

integer

shield_edit_field_inforequired

null

shield_follow_noticerequired

integer

short_idrequired

string

show_image_bubblerequired

boolean

signaturerequired

string

special_accountrequired

object

special_account_listrequired

null

special_lockrequired

integer

statusrequired

integer

stitch_settingrequired

integer

total_favoritedrequired

integer

tw_expire_timerequired

integer

twitter_idrequired

string

twitter_namerequired

string

type_labelrequired

null

uidrequired

string

unique_idrequired

string

unique_id_modify_timerequired

integer

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

youtube_channel_idrequired

string

youtube_channel_titlerequired

string

youtube_expire_timerequired

integer

is_mute_thoughtoptional

integer

author_user_idoptional

integer

aweme_acloptional

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

array

Array items

object

coderequired

integer

show_typerequired

integer

toast_msgrequired

string

extrarequired

string

action_idrequired

string

share_generalrequired

object

coderequired

integer

muterequired

boolean

show_typerequired

integer

transcoderequired

integer

extraoptional

string

share_list_statusrequired

integer

aweme_idrequired

string

aweme_typeoptional

integer

bannersoptional

array

Array items

object

keyrequired

object

component_keyrequired

string

behind_the_song_music_idsoptional

null

behind_the_song_video_music_idsoptional

null

bodydance_scoreoptional

integer

branded_content_accountsoptional

null

c2pa_infooptional

object

aigc_srcrequired

string

dedup_errrequired

string

dedup_srcrequired

string

first_aigc_srcrequired

string

first_srcrequired

string

is_capcutrequired

boolean

is_tiktokrequired

boolean

last_aigc_srcrequired

string

last_srcrequired

string

total_audiorequired

integer

total_errrequired

integer

total_imgrequired

integer

total_srcrequired

integer

total_vidrequired

integer

upload_durrequired

schema

anyOf

number

anyOf

integer

c2pa_extra_dataoptional

string

cc_template_infooptional

object

author_namerequired

string

clip_countrequired

integer

descrequired

string

duration_millisecondsrequired

integer

related_music_idrequired

string

template_idrequired

string

cha_listoptional

null

challenge_positionoptional

null

cmt_swtoptional

boolean

collect_statoptional

integer

comment_configoptional

object

comment_panel_show_tab_configrequired

object

max_tab_countrequired

integer

comment_tab_info_configrequired

array

Array items

object

tab_idrequired

integer

tab_namerequired

string

priorityrequired

integer

emoji_recommend_listrequired

array

Array items

object

emojirequired

string

scorerequired

integer

emoji_idrequired

string

emoji_id_scorerequired

integer

long_press_recommend_listrequired

null

preloadrequired

object

predsrequired

string

quick_commentrequired

object

enabledrequired

boolean

rec_leveloptional

integer

quick_comment_emoji_recommend_listrequired

null

zero_comment_button_configoptional

object

background_urlrequired

object

url_listrequired

array

Array items

string

url_prefixrequired

null

zero_comment_button_main_textrequired

string

zero_comment_button_textrequired

string

zero_comment_button_enablerequired

boolean

image_typerequired

integer

background_url_for_blackrequired

object

url_listrequired

array

Array items

string

url_prefixrequired

null

comment_top_bar_componentoptional

array

Array items

object

template_typerequired

integer

biz_typerequired

integer

namerequired

string

desc_prefixrequired

object

contentrequired

string

desc_suffixrequired

object

contentrequired

string

tail_iconrequired

object

is_localrequired

boolean

local_typerequired

integer

actionrequired

object

schemarequired

string

click_hot_area_typerequired

integer

extrarequired

string

tracer_inforequired

string

biz_idrequired

string

social_quick_commentoptional

object

enabledrequired

boolean

rec_metricsrequired

object

non_social_enabledrequired

string

p_commentrequired

string

p_skiprequired

string

p_stay_timerequired

string

has_author_commentoptional

boolean

has_visual_commentoptional

boolean

comment_topbar_infooptional

null

commerce_config_dataoptional

null

commerce_infooptional

object

adv_promotablerequired

boolean

auction_ad_invitedrequired

boolean

branded_content_typerequired

integer

organic_log_extrarequired

string

with_comment_filter_wordsrequired

boolean

is_diversion_adoptional

integer

ad_sourceoptional

integer

content_descoptional

string

content_desc_extraoptional

array

content_modeloptional

object

custom_bizrequired

object

aweme_tracerequired

string

high_quality_boost_infooptional

object

descriptionrequired

string

linkrequired

string

is_high_quality_postrequired

boolean

high_quality_boost_info_v2optional

object

standard_bizrequired

object

creator_analyticsrequired

object

creator_analytics_entrance_statusrequired

integer

e_commercerequired

object

ttec_content_tagrequired

object

recommendation_tag_consumer_strrequired

string

recommendation_tag_creator_strrequired

string

local_alliance_inforequired

object

alliance_item_label_textrequired

string

alliance_item_label_typerequired

integer

tts_voice_inforequired

object

tts_voice_attrrequired

string

tts_voice_reuse_paramsrequired

string

vc_filter_inforequired

object

vc_filter_attrrequired

string

ai_comment_photooptional

object

enable_commentrequired

boolean

penalty_contextoptional

object

arb_content_safety_statusrequired

integer

reviewedrequired

integer

statusrequired

integer

tns_statusrequired

integer

video_statusrequired

integer

conclu_calculated_timerequired

integer

conclu_lifecycle_reasonrequired

integer

conclu_lifecycle_statusrequired

integer

display_penalty_typerequired

integer

display_policyrequired

integer

display_ui_typerequired

integer

aweme_typerequired

integer

is_visitor_ownerrequired

boolean

conclu_refine_reasonrequired

integer

ec_global_verdictoptional

integer

interactionoptional

object

collectrequired

object

creation_ideas_inforequired

object

eligiblerequired

boolean

meme_ugcoptional

object

meme_name_v1required

string

music_level_v1required

integer

video_level_v1required

integer

baseoptional

object

statusrequired

object

rate_inforequired

object

minor_riskrequired

object

p0required

integer

p1required

integer

p2required

integer

content_original_typeoptional

integer

content_size_typeoptional

integer

content_typeoptional

string

cover_labelsoptional

null

create_timerequired

integer

creation_infooptional

object

creation_used_functionsrequired

array

Array items

string

descrequired

string

desc_languagerequired

string

disable_search_trending_baroptional

boolean

distanceoptional

string

distribute_typeoptional

integer

follow_up_item_id_groupsoptional

string

follow_up_publish_from_idoptional

integer

geofencingoptional

null

geofencing_regionsoptional

null

green_screen_materialsoptional

null

group_idoptional

string

group_id_listoptional

object

GroupdIdList0required

array

Array items

integer

GroupdIdList1required

array

Array items

integer

has_danmakuoptional

boolean

has_promote_entryoptional

integer

has_vs_entryoptional

boolean

have_dashboardoptional

boolean

hybrid_labeloptional

null

image_infosoptional

null

interact_permissionoptional

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_stickersoptional

array

Array items

object

typerequired

integer

indexrequired

integer

is_non_globalrequired

boolean

track_inforequired

string

attrrequired

string

text_inforequired

string

text_sticker_inforequired

object

text_sizerequired

integer

text_colorrequired

string

bg_colorrequired

string

text_languagerequired

string

alignmentrequired

integer

source_widthrequired

number

source_heightrequired

number

material_indexrequired

integer

is_non_global_v2required

boolean

is_adsoptional

boolean

is_description_translatableoptional

boolean

is_hash_tagoptional

integer

is_nff_or_nroptional

boolean

is_on_this_dayoptional

integer

is_pgcshowoptional

boolean

is_previewoptional

integer

is_relieveoptional

boolean

is_text_sticker_translatableoptional

boolean

is_title_translatableoptional

boolean

is_topoptional

integer

is_vroptional

boolean

item_comment_settingsoptional

integer

item_duetoptional

integer

item_reactoptional

integer

item_stitchoptional

integer

label_topoptional

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

label_top_textoptional

null

long_videooptional

null

main_arch_commonoptional

string

mask_infosoptional

array

meme_reg_infooptional

object

misc_infooptional

string

muf_comment_info_v2optional

null

musicoptional

object

albumrequired

string

allow_offline_music_to_detail_pagerequired

boolean

artistsrequired

array

Array items

object

uidrequired

string

sec_uidrequired

string

nick_namerequired

string

handlerequired

string

avatarrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

is_verifiedrequired

boolean

enter_typerequired

integer

follow_statusrequired

integer

is_visiblerequired

boolean

follower_statusrequired

integer

is_private_accountrequired

boolean

is_blockrequired

boolean

is_blockedrequired

boolean

statusrequired

integer

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

number

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

duration_precisionrequired

schema

anyOf

number

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

shoot_duration_precisionrequired

schema

anyOf

number

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

anyOf

integer

anyOf

number

anyOf

number

video_duration_precisionrequired

schema

anyOf

number

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

number

anyOf

integer

anyOf

number

anyOf

integer

anyOf

integer

anyOf

number

anyOf

number

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

log_extrarequired

string

lyric_short_positionrequired

null

meme_song_inforequired

object

midrequired

string

multi_bit_rate_play_inforequired

null

mute_sharerequired

boolean

offline_descrequired

string

owner_handlerequired

string

owner_idoptional

string

owner_nicknamerequired

string

play_urlrequired

object

heightrequired

integer

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

positionrequired

null

prevent_downloadrequired

boolean

preview_end_timerequired

integer

preview_start_timerequired

integer

recommend_statusrequired

integer

search_highlightrequired

null

sec_uidoptional

string

shoot_durationrequired

integer

source_platformrequired

integer

statusrequired

integer

tag_listrequired

null

titlerequired

string

tt_to_dsp_song_infosrequired

null

uncert_artistsrequired

null

user_countrequired

integer

video_durationrequired

integer

strong_beat_urloptional

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

url_prefixrequired

null

matched_pgc_soundoptional

object

authorrequired

string

titlerequired

string

mixed_titlerequired

string

mixed_authorrequired

string

music_release_inforequired

object

is_new_release_songrequired

boolean

group_release_daterequired

integer

artist_infosrequired

array

Array items

object

uidrequired

string

sec_uidrequired

string

nick_namerequired

string

handlerequired

string

avatarrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

is_verifiedrequired

boolean

enter_typerequired

integer

follow_statusrequired

integer

is_visiblerequired

boolean

follower_statusrequired

integer

is_private_accountrequired

boolean

is_blockrequired

boolean

is_blockedrequired

boolean

statusrequired

integer

uncert_artistsrequired

null

cover_mediumrequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

url_prefixrequired

null

matched_songoptional

object

idrequired

string

authorrequired

string

titlerequired

string

h5_urlrequired

string

cover_mediumrequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

url_prefixrequired

null

performersrequired

null

chorus_inforequired

object

start_msrequired

integer

duration_msrequired

integer

full_durationrequired

integer

versesrequired

null

chorusesrequired

null

style_valueoptional

array

Array items

integer

theme_valueoptional

array

Array items

integer

languageoptional

string

theme_tagsoptional

array

Array items

string

music_group_use_countoptional

integer

music_group_v3_idsoptional

array

Array items

integer

has_human_voiceoptional

boolean

mute_typeoptional

integer

same_group_id_v3optional

integer

sim_group_id_v3optional

integer

music_ugidoptional

integer

music_ugid_use_countoptional

integer

has_commerce_right_strictoptional

boolean

is_commerce_music_strictoptional

boolean

tag_list_v2optional

null

music_release_infooptional

object

is_new_release_songrequired

boolean

group_release_daterequired

integer

is_unlimited_musicoptional

boolean

lyric_scene_copyrightoptional

object

lyric_stickerrequired

boolean

lyricsoptional

array

Array items

object

lyric_idrequired

integer

lyric_typerequired

integer

music_begin_time_in_msoptional

integer

music_end_time_in_msoptional

integer

music_selected_fromoptional

string

music_title_styleoptional

integer

music_volumeoptional

string

need_trim_stepoptional

boolean

need_vs_entryoptional

boolean

nickname_positionoptional

null

no_selected_musicoptional

boolean

operator_boost_infooptional

null

origin_comment_idsoptional

null

origin_volumeoptional

string

original_client_textoptional

object

markup_textrequired

string

text_extrarequired

array

Array items

object

user_idrequired

string

typerequired

integer

sec_uidrequired

string

tag_idrequired

string

picked_usersoptional

array

playlist_blockedoptional

boolean

playlist_infooptional

object

indexrequired

integer

item_totalrequired

integer

mix_idrequired

string

namerequired

string

poi_re_tag_signaloptional

integer

positionoptional

null

prevent_downloadoptional

boolean

products_infooptional

null

promote_capcut_toggleoptional

integer

promote_icon_textoptional

string

promote_toastoptional

string

promote_toast_keyoptional

string

question_listoptional

null

quick_reply_emojisoptional

array

Array items

string

rateoptional

integer

reference_tts_voice_idsoptional

null

reference_voice_filter_idsoptional

null

regionrequired

string

risk_infosoptional

object

contentrequired

string

risk_sinkrequired

boolean

typerequired

integer

voterequired

boolean

warnrequired

boolean

search_highlightoptional

null

share_infooptional

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_urloptional

string

shoot_tab_nameoptional

string

social_interaction_bloboptional

object

auxiliary_model_contentrequired

string

solaria_profileoptional

object

profileoptional

string

sort_labeloptional

string

standard_component_infooptional

object

banner_enabledoptional

boolean

buttonoptional

object

buttonsrequired

array

Array items

object

keyrequired

object

component_keyrequired

string

signalrequired

object

coderequired

integer

auto_displayrequired

boolean

releasablerequired

boolean

uirequired

object

ui_typerequired

integer

templaterequired

object

typerequired

integer

fieldsrequired

string

actionsrequired

array

Array items

object

keyrequired

string

eventsrequired

array

Array items

object

typerequired

string

enable_standard_buttonrequired

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

statusoptional

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

support_danmakuoptional

boolean

text_extraoptional

array

Array items

object

startrequired

integer

endrequired

integer

user_idrequired

string

typerequired

integer

sec_uidrequired

string

tag_idrequired

string

text_sticker_major_langoptional

string

title_languageoptional

string

ttec_suggest_wordsoptional

object

ttec_suggest_wordsrequired

null

tts_voice_idsoptional

null

ttt_product_recall_typeoptional

integer

uniqid_positionoptional

null

upvote_infooptional

object

friends_recall_inforequired

string

repost_initiate_scorerequired

integer

user_upvotedrequired

boolean

upvote_preloadoptional

object

need_pull_upvote_inforequired

boolean

used_full_songoptional

boolean

user_diggedoptional

integer

videorequired

object

CoverTspoptional

schema

anyOf

number

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

schema

anyOf

integer

anyOf

number

anyOf

integer

anyOf

integer

anyOf

integer

anyOf

integer

anyOf

integer

ai_dynamic_coverrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthoptional

integer

heightoptional

integer

data_sizeoptional

integer

ai_dynamic_cover_bakrequired

object

urirequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthoptional

integer

heightoptional

integer

data_sizeoptional

integer

animated_coveroptional

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

cover_is_customoptional

boolean

download_addrrequired

object

data_sizeoptional

integer

file_csoptional

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

misc_download_addrsrequired

schema

anyOf

string

anyOf

object

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_sizeoptional

integer

file_csoptional

string

file_hashoptional

string

heightrequired

integer

urirequired

string

url_keyrequired

string

url_listrequired

array

Array items

string

url_prefixrequired

null

widthrequired

integer

ratiorequired

string

source_HDR_typeoptional

integer

tagsrequired

null

video_modeloptional

string

widthrequired

integer

did_profile_labelsoptional

string

play_addr_bytevc1optional

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_h264optional

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

vid_profile_labelsoptional

string

cover_rgboptional

string

video_controloptional

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_labelsoptional

array

video_textoptional

array

visual_search_infooptional

object

vtag_enableoptional

boolean

long_press_entrance_enableoptional

boolean

fallback_vtag_enableoptional

boolean

visual_search_intent_leveloptional

integer

screenshot_entrance_enableoptional

integer

vtag_enable_typeoptional

integer

fallback_vtag_enable_typeoptional

integer

long_press_entrance_enable_typeoptional

integer

enable_pre_upload_image_typeoptional

integer

voice_filter_idsoptional

null

with_promotional_musicoptional

boolean

without_watermarkoptional

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

image_post_infooptional

object

imagesrequired

array

Array items

object

display_imagerequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

data_sizerequired

integer

url_prefixrequired

null

owner_watermark_imagerequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

data_sizerequired

integer

url_prefixrequired

null

user_watermark_imagerequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

data_sizerequired

integer

url_prefixrequired

null

thumbnailrequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

data_sizerequired

integer

url_prefixrequired

null

bitrate_imagesrequired

array

ocr_languageoptional

string

image_post_coverrequired

object

display_imagerequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

data_sizerequired

integer

url_prefixrequired

null

owner_watermark_imagerequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

data_sizerequired

integer

url_prefixrequired

null

user_watermark_imagerequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

data_sizerequired

integer

url_prefixrequired

null

thumbnailrequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

data_sizerequired

integer

url_prefixrequired

null

bitrate_imagesrequired

array

music_volumerequired

number

titlerequired

string

translation_inforequired

object

translatablerequired

boolean

target_languagerequired

string

image_major_languagerequired

string

post_extrarequired

string

suggest_wordsoptional

object

suggest_wordsrequired

array

Array items

object

wordsrequired

array

Array items

object

wordrequired

string

word_idrequired

string

penetrate_inforequired

string

word_recordrequired

object

words_langrequired

string

is_personalizedrequired

boolean

words_labelrequired

string

qrec_json_inforequired

string

rich_sug_inforequired

object

sug_reasonrequired

string

sug_reason_typerequired

string

sug_icon_urirequired

string

sug_icon_typerequired

string

scenerequired

string

hint_textrequired

string

qrec_virtual_enablerequired

string

feed_query_enable_videosugrequired

boolean

is_paid_contentoptional

boolean

paid_content_infooptional

object

paid_collection_idrequired

integer

is_paid_collection_introrequired

boolean

categoryrequired

integer

episode_numrequired

integer

should_show_series_purchase_labelrequired

boolean

follow_up_first_item_idoptional

string

content_leveloptional

integer

promoteoptional

object

is_show_video_viewrequired

boolean

video_view_schemarequired

string

video_view_countrequired

integer

promote_traffic_tagrequired

object

traffic_levelrequired

integer

need_trackrequired

boolean

versionrequired

string

extrarequired

string

smart_search_infooptional

object

find_similar_intent_typerequired

integer

ask_tako_intent_typerequired

integer

related_videos_intent_typerequired

integer

title_smart_search_panel_typerequired

integer

ai_overview_intent_typerequired

integer

survey_infooptional

null

ecosystem_perception_enhancementoptional

null

creator_ai_commentoptional

object

has_ai_topicrequired

boolean

eligible_videorequired

boolean

not_eligible_reasonrequired

integer

tako_bubble_infooptional

object

tako_bubble_enablerequired

boolean

bottom_productsoptional

null

right_productsoptional

null

comment_at_tako_infooptional

object

show_tako_accountrequired

integer

ai_remix_infooptional

object

has_entrancerequired

boolean

item_allow_ai_remixoptional

integer

story_remix_infooptional

object

is_support_remixrequired

boolean

is_close_friends_onlyoptional

boolean

ad_aweme_sourceoptional

integer

collab_infooptional

object

should_display_tagrequired

boolean

collaboratorsrequired

array

Array items

object

user_inforequired

object

uidrequired

string

nicknamerequired

string

avatar_thumbrequired

object

urirequired

string

url_listrequired

array

Array items

string

widthrequired

integer

heightrequired

integer

data_sizerequired

integer

url_prefixrequired

null

follow_statusrequired

integer

follower_countrequired

integer

custom_verifyrequired

string

unique_idrequired

string

enterprise_verify_reasonrequired

string

followers_detailrequired

null

platform_sync_inforequired

null

secretrequired

integer

geofencingrequired

null

cover_urlrequired

null

item_listrequired

null

type_labelrequired

null

ad_cover_urlrequired

null

relative_usersrequired

null

cha_listrequired

null

need_pointsrequired

null

homepage_bottom_toastrequired

null

can_set_geofencingrequired

null

white_cover_urlrequired

null

user_tagsrequired

null

bold_fieldsrequired

null

search_highlightrequired

null

mutual_relation_avatarsrequired

null

eventsrequired

null

advance_feature_item_orderrequired

null

advanced_feature_inforequired

null

user_profile_guiderequired

null

shield_edit_field_inforequired

null

can_message_follow_status_listrequired

null

account_labelsrequired

null

collab_statusrequired

integer

extraoptional

object

fatal_item_idsrequired

array

logidrequired

string

nowrequired

integer

has_locate_itemoptional

boolean

has_moreoptional

integer

log_pboptional

object

impr_idrequired

string

max_cursorrequired

integer

min_cursoroptional

integer

status_codeoptional

integer

status_msgoptional

string

401Invalid or missing x-api-key

402No credits remaining

403Upstream denied (age gate, audience controls)

404Resource or endpoint not found

429Rate limited