Claw API 接口文档

基础信息


1. 视频解析接口

接口描述

解析抖音或小红书视频信息,提取视频元数据、文案、作者信息等。

请求信息

请求方法: POST

请求路径: /api/v1/claw/account/parse

支持平台:

请求参数

字段名类型必填说明
apiKeyString用户 API 密钥,用于身份验证和积分扣除
urlString视频链接地址(支持抖音和小红书)

请求示例:

响应参数

成功响应 (success: true):

字段名类型说明
successBoolean请求状态,true 表示成功
costInteger本次请求消耗的积分数量
quotaInteger用户剩余积分数量
dataObject视频详细信息对象
messageString成功时为空

data 字段说明:

data 是一个对象,包含视频的所有详细信息:

字段名类型说明
titleString视频标题
keywordsArray从视频描述中提取的话题标签(hashtag)
summaryString视频描述/文案
like_countLong点赞数
comment_countLong评论数
collect_countLong收藏数
share_countLong分享数
author_nameString作者昵称
publish_timeString发布时间(格式化后的字符串)
audio_urlString音频文件 URL
video_urlString视频文件 URL
transcriptString视频语音转文字结果(AI 识别的文案)
cover_urlString视频封面图片 URL
follower_countLong作者粉丝数

抖音视频响应示例:

失败响应 (success: false):

字段名类型说明
successBoolean请求状态,false 表示失败
messageString错误信息描述

失败示例:


2. 获取用户积分接口

接口描述

查询指定 API Key 对应的用户积分余额。

请求信息

请求方法: GET

请求路径: /api/v1/claw/user/get_quota

请求参数

参数名类型必填说明
apiKeyString用户 API 密钥

请求示例:

响应参数

成功响应 (success: true):

字段名类型说明
successBoolean请求状态,true 表示成功
costInteger本次请求消耗的积分数量(固定为 0)
quotaInteger用户剩余积分数量
dataString当前服务器时间(格式:yyyy/MM/dd HH:mm)
messageString成功时为空

响应示例:

失败响应 (success: false):

字段名类型说明
successBoolean请求状态,false 表示失败
messageString错误信息描述

失败示例:


3. 采集账号视频列表接口

接口描述

采集抖音或小红书账号的视频列表,支持按互动量筛选和最近天数过滤。

请求信息

请求方法: POST

请求路径: /api/v1/claw/account/collect/videos

支持平台:

请求参数

字段名类型必填默认值说明
apiKeyString-用户 API 密钥,用于身份验证和积分扣除
urlString-账号主页链接地址(支持抖音和小红书)
recentDayInteger180最近天数,只采集指定天数内的视频
maxSizeInteger-最大获取数量,不传则返回所有符合条件的视频
minDiggLong0最低点赞量,低于此值的视频将被过滤
minCommentLong0最低评论量,低于此值的视频将被过滤
minCollectLong0最低收藏量,低于此值的视频将被过滤

请求示例:

响应参数

成功响应 (success: true):

字段名类型说明
successBoolean请求状态,true 表示成功
costInteger本次请求消耗的积分数量(按实际返回视频数量计算)
quotaInteger用户剩余积分数量
dataArray视频列表数组
messageString成功时为空

抖音视频 data 字段说明:

data 是一个数组,每个元素表示一个视频:

字段名类型说明
titleString视频标题/描述
author_nicknameString作者昵称
typeString视频类型:video(视频)、image(图文)、other(其他)
like_countInteger点赞数
comment_countInteger评论数
collect_countInteger收藏数
share_countInteger转发/分享数
publish_timeLong发布时间戳(毫秒)
share_urlObject分享链接对象,包含 text 和 link 字段
cover_urlString视频封面图片 URL
video_urlString视频文件下载地址(仅视频类型)
audio_urlString音频文件下载地址(仅视频类型)

抖音视频响应示例:

小红书视频 data 字段说明:

字段名类型说明
titleString笔记标题
author_nicknameString作者昵称
typeString类型(固定为"video",只返回视频类型笔记)
like_countLong点赞数
comment_countLong评论数
collect_countLong收藏数
share_countLong分享数
publish_timeLong发布时间戳(毫秒)
share_urlObject分享链接对象,包含 text 和 link 字段
video_urlString视频文件下载地址

小红书视频响应示例:

失败响应 (success: false):

字段名类型说明
successBoolean请求状态,false 表示失败
messageString错误信息描述

失败示例:


4. 采集账号数据接口

接口描述

采集抖音或小红书账号信息,包括粉丝数、作品数、账号简介等数据。

请求信息

请求方法: POST

请求路径: /api/v1/claw/account/collect/info

支持平台:

请求参数

字段名类型必填说明
apiKeyString用户 API 密钥,用于身份验证和积分扣除
urlString账号主页链接地址(支持抖音和小红书)

请求示例:

响应参数

成功响应 (success: true):

字段名类型说明
successBoolean请求状态,true 表示成功
costInteger本次请求消耗的积分数量
quotaInteger用户剩余积分数量
dataObject账号详细信息对象
messageString成功时为空

抖音账号 data 字段说明:

data 是一个对象,包含账号的所有详细信息:

字段名类型说明
home_page_urlString主页链接
nicknameString昵称
signatureString账号简介/个性签名
douyin_idString抖音号(优先使用 unique_id,为空则使用 short_id)
following_countLong关注数
follower_countLong粉丝数
max_follower_countLong粉丝数峰值(历史最高粉丝数)
total_favoritedLong获赞总数(赞藏量)
aweme_countLong作品数
ip_locationStringIP 属地(如"北京"、"上海"等),可能不存在

抖音账号响应示例:

小红书账号 data 字段说明:

data 是一个对象,包含账号的所有详细信息:

字段名类型说明
home_page_urlString主页链接
nicknameString昵称
signatureString账号简介
red_idString小红书号
following_countLong关注数
follower_countLong粉丝数
max_follower_countLong粉丝数峰值
liked_countLong获赞总数(赞藏量)
notes_countLong作品数(笔记数)
ip_locationStringIP 属地

小红书账号响应示例:

失败响应 (success: false):

字段名类型说明
successBoolean请求状态,false 表示失败
messageString错误信息描述

失败示例:


5. 对话接口

接口描述

使用预设的 Prompt 模板进行 AI 对话,支持多种 AI 模型(OpenAI、Siliconflow、Volcengine)。

请求信息

请求方法: POST

请求路径: /api/v1/claw/chat/{path}

路径参数:

参数名类型必填说明
pathStringPrompt 模板的路径标识,用于指定使用哪个预设的对话模板

请求参数

字段名类型必填说明
apiKeyString用户 API 密钥,用于身份验证和积分扣除
messageString用户输入的消息内容

请求示例:

响应参数

成功响应 (success: true):

字段名类型说明
successBoolean请求状态,true 表示成功
costInteger本次请求消耗的积分数量(根据字符数和模板倍率计算)
quotaInteger用户剩余积分数量
dataStringAI 返回的对话内容
messageString成功时为空

响应示例:

失败响应 (success: false):

字段名类型说明
successBoolean请求状态,false 表示失败
messageString错误信息描述

失败示例:


6. 图片生成接口

接口描述

使用 Seedream 模型生成图片,支持自定义提示词、图片尺寸、数量和参考图片。

请求信息

请求方法: POST

请求路径: /api/v1/claw/seedream/images/generations

请求参数

字段名类型必填默认值说明
apiKeyString-用户 API 密钥,用于身份验证和积分扣除
messageString-图片生成的提示词
sizeString-生成图片的尺寸(如 "1024x1024")
nInteger-生成图片的数量
imageArray-参考图片的 URL 数组

请求示例:

响应参数

成功响应 (success: true):

字段名类型说明
successBoolean请求状态,true 表示成功
costInteger本次请求消耗的积分数量
quotaInteger用户剩余积分数量
dataArray生成的图片 URL 数组(已上传到 COS)
messageString成功时为空

响应示例:

失败响应 (success: false):

字段名类型说明
successBoolean请求状态,false 表示失败
messageString错误信息描述

失败示例:


7. 关键词搜索视频接口

接口描述

根据关键词搜索抖音视频,支持按互动量筛选和日期过滤,并将结果写入飞书多维表格。

请求信息

请求方法: POST

请求路径: /api/v1/claw/search/videos

请求参数

字段名类型必填默认值说明
apiKeyString-用户 API 密钥,用于身份验证和积分扣除
keywordString-搜索关键词
appTokenString-飞书多维表格的 App Token(用于写入数据)
lastDayString-起始日期(格式:yyyy/MM/dd),只采集此日期之后的视频
minDiggLong0最低点赞量,低于此值的视频将被过滤
minCommentLong0最低评论量,低于此值的视频将被过滤
minCollectLong0最低收藏量,低于此值的视频将被过滤
minShareLong0最低转发量,低于此值的视频将被过滤

请求示例:

响应参数

成功响应 (success: true):

字段名类型说明
successBoolean请求状态,true 表示成功
costInteger本次请求消耗的积分数量
quotaInteger用户剩余积分数量
dataArray视频数据数组(已写入飞书表格)
messageString成功时为空

data 字段说明:

每个视频记录包含以下字段:

字段名类型说明
作品标题String视频标题/描述
账号名String作者昵称
类型String视频类型(视频/图文/其他)
点赞量Integer点赞数
评论量Integer评论数
收藏量Integer收藏数
转发量Integer转发数
发布时间Long发布时间戳(毫秒)
分享链接Object分享链接对象,包含 text 和 link 字段
封面图链接String视频封面图片 URL
视频下载地址String视频文件下载地址
视频音频下载地址String音频文件下载地址
关键词String搜索关键词

响应示例:

失败响应 (success: false):

字段名类型说明
successBoolean请求状态,false 表示失败
messageString错误信息描述

失败示例:


8. 批量关键词搜索视频接口

接口描述

从飞书表格批量读取关键词及筛选条件,搜索对应的抖音视频并写入目标表格。

请求信息

请求方法: POST

请求路径: /api/v1/claw/search/collect/keyword-batch

请求参数

字段名类型必填说明
apiKeyString用户 API 密钥,用于身份验证和积分扣除
fromAppTokenString源飞书多维表格的 App Token(读取关键词数据)
toAppTokenString目标飞书多维表格的 App Token(写入搜索结果)
keywordFieldNameString源表格中关键词字段的名称
selectedFieldNameString源表格中用于筛选的字段名称(值为 true 的记录会被处理)
lastDayFieldNameString源表格中日期字段的名称
minDiggFieldNameString源表格中最低点赞量字段的名称
minCommentFieldNameString源表格中最低评论量字段的名称
minCollectFieldNameString源表格中最低收藏量字段的名称
minShareFieldNameString源表格中最低转发量字段的名称

请求示例:

响应参数

成功响应 (success: true):

字段名类型说明
successBoolean请求状态,true 表示成功
costInteger本次请求消耗的积分数量(按实际处理的关键词数量计算)
quotaInteger用户剩余积分数量
dataArray各关键词的搜索结果数组
messageString成功时为空

响应示例:

失败响应 (success: false):

字段名类型说明
successBoolean请求状态,false 表示失败
messageString错误信息描述

失败示例:


9. 热榜采集接口

接口描述

采集多个平台的热榜数据,包括抖音、小红书、百度和微博,支持关键词筛选。

请求信息

请求方法: POST

请求路径: /api/v1/claw/hotlist/getHotList

请求参数

字段名类型必填说明
apiKeyString用户 API 密钥,用于身份验证和积分扣除
appTokenString飞书多维表格的 App Token(用于写入数据)
keyString筛选关键词,只返回标题包含此关键词的热榜内容

请求示例:

响应参数

成功响应 (success: true):

字段名类型说明
successBoolean请求状态,true 表示成功
costInteger本次请求消耗的积分数量
quotaInteger用户剩余积分数量
dataObject包含各平台热榜数据的对象
messageString成功时为空

data 字段说明:

data 对象包含以下四个平台的热榜数据:

字段名类型说明
douyinArray抖音热榜数据数组
xhsArray小红书热榜数据数组
baiduArray百度热榜数据数组
weiboArray微博热榜数据数组

每个热榜项包含以下字段:

字段名类型说明
标题Object热榜标题对象,包含 text 和 link 字段
关键词String筛选关键词
热度值Long热度值数值
平台String平台名称(抖音/小红书/百度/微博)

响应示例:

失败响应 (success: false):

字段名类型说明
successBoolean请求状态,false 表示失败
messageString错误信息描述

失败示例: