OpenAPI
videos search
/v1/videos/search- Authentication
- X-API-Key
- Required scope
video:search- Billing
- Pricing follows your active account rules
- Rate limits
- View your active rate limits
Parameters
Send this request as a JSON body.
platformstringRequired平台:tiktok / youtube / instagram(必填)
query_typestringOptional达人标识符类型:union_user_id(默认,达人唯一ID)/ kol_page_url(达人主页URL)/ user_name(用户名)
Default: "union_user_id"
union_user_id · kol_page_url · user_name
union_user_idsarrayOptional达人标识符列表,具体含义由 query_type 决定(可选筛选条件)
Show fields
Schema details are unavailable for this endpoint.
hashtagarrayOptionalHashtag 列表(精确匹配,最多 5 个)
Show fields
Schema details are unavailable for this endpoint.
video_titlestringOptional视频标题关键词(模糊匹配)
video_views_cnt_gteintegerOptional最小播放量
0 ≤ video_views_cnt_gte ≤ 1000000000
video_views_cnt_lteintegerOptional最大播放量
0 ≤ video_views_cnt_lte ≤ 1000000000
video_interaction_rate_gtenumberOptional最小互动率(百分比,如 5.5 表示 5.5%)
0 ≤ video_interaction_rate_gte ≤ 100
video_interaction_rate_ltenumberOptional最大互动率(百分比,如 5.5 表示 5.5%)
0 ≤ video_interaction_rate_lte ≤ 100
video_publish_date_gtestringOptional发布日期起始(格式:YYYY-MM-DD,不传则不按发布日期筛选)
video_publish_date_ltestringOptional发布日期截止(格式:YYYY-MM-DD)
pageintegerOptional页码(1-10)
Default: 1
1 ≤ page ≤ 10
sizeintegerOptional每页数量(固定 10)
Default: 10
1 ≤ size ≤ 10
Response
successbooleanRequireddataarrayOptionalShow fields
Schema details are unavailable for this endpoint.
errorobjectOptional错误详情
Show fields
codeintegerRequired业务错误码
messagestringRequired可读错误信息
metaobjectOptional响应元数据
Show fields
request_idstringOptional请求唯一标识
Default: ""
pageintegerOptional当前页码
sizeintegerOptional每页数量
totalintegerOptional总数
quota_remainingintegerOptional剩余配额(-1 表示不限制)
Default: -1
service_levelstringOptional本次请求的服务等级
langstringOptional响应语言(cn/en),为空表示未翻译
platformstringOptional本次请求的达人平台
recall_typestringOptional召回类型:hybrid / vector / scalar
credits_consumedintegerOptional本次请求扣减的积分数
Default: 0
credits_remainingintegerOptional积分余额(-1 不限制)
Default: -1
billable_unitsintegerOptionalServer-calculated billable units for this response
Default: 0
0 ≤ billable_units ≤ ∞
skill_namestringOptional调用方 skill 名称
skill_current_versionstringOptional调用方 skill 当前版本
skill_latest_versionstringOptional服务端声明的最新 skill 版本
skill_min_supported_versionstringOptional服务端声明的最低支持版本
skill_update_availablebooleanOptional是否存在可用 skill 更新
Default: false
skill_update_requiredbooleanOptional是否要求更新 skill 后再继续使用
Default: false
skill_update_messagestringOptionalskill 更新提示文案
skill_update_manifest_urlstringOptionalskill 更新 manifest URL