DeveloperDocs.api

搜索视频（跨平台）

POST/v1/videos/search

DeveloperDocs.authentication: X-API-Key
DeveloperDocs.permission: video:search
DeveloperDocs.billing: DeveloperDocs.configuredBilling
DeveloperDocs.limits: DeveloperDocs.configuredLimits

DeveloperDocs.parameters

DeveloperDocs.jsonBody

platformstringDeveloperDocs.required

平台：tiktok / youtube / instagram（必填）

query_typestringDeveloperDocs.optional

达人标识符类型：union_user_id（默认，达人唯一ID）/ kol_page_url（达人主页URL）/ user_name（用户名）

DeveloperDocs.defaultValue: "union_user_id"

union_user_id · kol_page_url · user_name

union_user_idsarrayDeveloperDocs.optional

达人标识符列表，具体含义由 query_type 决定（可选筛选条件）

DeveloperDocs.showFields

DeveloperDocs.schemaUnavailable

hashtagarrayDeveloperDocs.optional

Hashtag 列表（精确匹配，最多 5 个）

DeveloperDocs.showFields

DeveloperDocs.schemaUnavailable

video_titlestringDeveloperDocs.optional

视频标题关键词（模糊匹配）

video_views_cnt_gteintegerDeveloperDocs.optional

最小播放量

0 ≤ video_views_cnt_gte ≤ 1000000000

video_views_cnt_lteintegerDeveloperDocs.optional

最大播放量

0 ≤ video_views_cnt_lte ≤ 1000000000

video_interaction_rate_gtenumberDeveloperDocs.optional

最小互动率（百分比，如 5.5 表示 5.5%）

0 ≤ video_interaction_rate_gte ≤ 100

video_interaction_rate_ltenumberDeveloperDocs.optional

最大互动率（百分比，如 5.5 表示 5.5%）

0 ≤ video_interaction_rate_lte ≤ 100

video_publish_date_gtestringDeveloperDocs.optional

发布日期起始（格式：YYYY-MM-DD，不传则不按发布日期筛选）

video_publish_date_ltestringDeveloperDocs.optional

发布日期截止（格式：YYYY-MM-DD）

pageintegerDeveloperDocs.optional

页码（1-10）

DeveloperDocs.defaultValue: 1

1 ≤ page ≤ 10

sizeintegerDeveloperDocs.optional

每页数量（固定 10）

DeveloperDocs.defaultValue: 10

1 ≤ size ≤ 10

DeveloperDocs.response

successbooleanDeveloperDocs.required

dataarrayDeveloperDocs.optional

DeveloperDocs.showFields

DeveloperDocs.schemaUnavailable

errorobjectDeveloperDocs.optional

错误详情

DeveloperDocs.showFields

codeintegerDeveloperDocs.required

业务错误码

messagestringDeveloperDocs.required

可读错误信息

metaobjectDeveloperDocs.optional

响应元数据

DeveloperDocs.showFields

request_idstringDeveloperDocs.optional

请求唯一标识

DeveloperDocs.defaultValue: ""

pageintegerDeveloperDocs.optional

当前页码

sizeintegerDeveloperDocs.optional

每页数量

totalintegerDeveloperDocs.optional

总数

quota_remainingintegerDeveloperDocs.optional

剩余配额（-1 表示不限制）

DeveloperDocs.defaultValue: -1

service_levelstringDeveloperDocs.optional

本次请求的服务等级

langstringDeveloperDocs.optional

响应语言（cn/en），为空表示未翻译

platformstringDeveloperDocs.optional

本次请求的达人平台

recall_typestringDeveloperDocs.optional

召回类型：hybrid / vector / scalar

credits_consumedintegerDeveloperDocs.optional

本次请求扣减的积分数

DeveloperDocs.defaultValue: 0

credits_remainingintegerDeveloperDocs.optional

积分余额（-1 不限制）

DeveloperDocs.defaultValue: -1

billable_unitsintegerDeveloperDocs.optional

Server-calculated billable units for this response

DeveloperDocs.defaultValue: 0

0 ≤ billable_units ≤ ∞

skill_namestringDeveloperDocs.optional

调用方 skill 名称

skill_current_versionstringDeveloperDocs.optional

调用方 skill 当前版本

skill_latest_versionstringDeveloperDocs.optional

服务端声明的最新 skill 版本

skill_min_supported_versionstringDeveloperDocs.optional

服务端声明的最低支持版本

skill_update_availablebooleanDeveloperDocs.optional

是否存在可用 skill 更新

DeveloperDocs.defaultValue: false

skill_update_requiredbooleanDeveloperDocs.optional

是否要求更新 skill 后再继续使用

DeveloperDocs.defaultValue: false

skill_update_messagestringDeveloperDocs.optional

skill 更新提示文案

skill_update_manifest_urlstringDeveloperDocs.optional

skill 更新 manifest URL

DeveloperDocs.requestExample

curl -X POST 'https://openapi.creativault.ai/openapi/v1/videos/search' \
  -H 'Content-Type: application/json' \
  -H "X-API-Key: $CV_API_KEY" \
  --data '{
  "platform": "example",
  "query_type": "union_user_id",
  "page": 1,
  "size": 10
}'

DeveloperDocs.schemaExampleNotice

DeveloperDocs.responseExample

{
  "success": true,
  "data": [
    {}
  ],
  "error": null,
  "meta": {
    "request_id": "",
    "page": 1,
    "size": 1,
    "total": 1,
    "quota_remaining": -1,
    "service_level": "example",
    "lang": "example",
    "platform": "example",
    "recall_type": "example",
    "credits_consumed": 0,
    "credits_remaining": -1,
    "billable_units": 0,
    "skill_name": "example",
    "skill_current_version": "example",
    "skill_latest_version": "example",
    "skill_min_supported_version": "example",
    "skill_update_available": false,
    "skill_update_required": false,
    "skill_update_message": "example",
    "skill_update_manifest_url": "example"
  }
}

DeveloperDocs.errorHelp →