Developer

API 文档

抖虫开放接口文档:通过 API 调用视频文案提取与图片文案提取能力,支持任务查询、用量与并发查询。

前往管理 API Key

快速开始

  1. 开通旗舰版后,前往「API Key 管理」创建 API Key;API Secret 仅创建时展示一次,请立即保存。
  2. 所有请求携带 X-API-Key 与 X-API-Secret 请求头。
  3. 调用「创建转写任务」或「创建图片提取任务」接口提交链接,使用返回的 taskId 轮询对应「查询任务」接口获取结果。

Base URL

https://www.dousnap.com/prod-api/douchong-api/v1

认证方式

通过请求头传递 API 凭证,所有接口均需认证:

请求头必填说明
X-API-Key是创建 API Key 时返回的 apiKey
X-API-Secret是创建 API Key 时返回的 apiSecret(仅创建时可见)

错误码

code含义
200成功
401认证失败:API Key 或 Secret 错误、Key 已禁用或删除
601权益不足:API 为旗舰版专属权益,需升级旗舰版

资料下载

Python 示例包含创建任务 → 轮询查询 → 打印结果的完整流程;Markdown 文档含全部接口的参数说明与请求 / 响应示例。

接口列表

方法接口说明
POST/task/create创建单个转写任务
POST/batch/task/create批量创建转写任务(最多 10 条)
GET/task/query查询转写任务状态与结果
POST/image/task/create创建图片文案提取任务
GET/image/task/query查询图片任务状态与结果
GET/quota/usage查询转写时长用量
GET/quota/concurrency查询并发额度占用
POST

/task/create

创建转写任务

提交一条作品链接,创建视频文案提取任务,返回用于轮询的 taskId。

请求参数

参数类型必填说明
workUrlstring是作品分享链接,支持抖音、小红书、快手、B站、TikTok 等平台
targetLanguagestring否目标语言;默认 auto 不翻译、保持原语言,可选值见下方说明

targetLanguage 可选值:auto(默认,不翻译、保持原语言)、zh 中文、zh-TW 繁体中文、en 英语、ja 日语、ko 韩语、fr 法语、de 德语、es 西班牙语、pt 葡萄牙语、ru 俄语。传入列表外的值时不保证翻译效果。

请求示例

curl -X POST 'https://www.dousnap.com/prod-api/douchong-api/v1/task/create' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: your-api-key' \
  -H 'X-API-Secret: your-api-secret' \
  -d '{"workUrl": "https://v.douyin.com/xxxxxxxx/", "targetLanguage": "zh"}'

响应示例

{
  "code": 200,
  "msg": "任务已提交",
  "data": {
    "taskId": "1758518400123456789",
    "status": "WAITING",
    "message": "任务已提交,处理中"
  }
}
POST

/batch/task/create

批量创建转写任务

一次提交最多 10 条作品链接,逐条创建转写任务。

请求参数

参数类型必填说明
workUrlsstring[]是作品分享链接列表,单次最多 10 条

请求示例

curl -X POST 'https://www.dousnap.com/prod-api/douchong-api/v1/batch/task/create' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: your-api-key' \
  -H 'X-API-Secret: your-api-secret' \
  -d '{"workUrls": ["https://v.douyin.com/xxxxxxxx/", "https://www.xiaohongshu.com/explore/yyyyyyyy"]}'

响应示例

{
  "code": 200,
  "msg": "批量任务提交完成",
  "data": {
    "total": 2,
    "success": 1,
    "failed": 1,
    "results": [
      {
        "workUrl": "https://v.douyin.com/xxxxxxxx/",
        "success": true,
        "data": {
          "taskId": "1758518400123456789",
          "status": "WAITING"
        }
      },
      {
        "workUrl": "https://www.xiaohongshu.com/explore/yyyyyyyy",
        "success": false,
        "error": "链接过长,请检查后重试"
      }
    ]
  }
}
GET

/task/query

查询任务状态与结果

按 taskId 查询任务进度;任务完成后返回完整文案与作品信息。任务处理中时可间隔数秒轮询。

请求参数

参数类型必填说明
taskIdstring是任务ID,创建任务时返回

请求示例

curl 'https://www.dousnap.com/prod-api/douchong-api/v1/task/query?taskId=1758518400123456789' \
  -H 'X-API-Key: your-api-key' \
  -H 'X-API-Secret: your-api-secret'

响应示例(任务成功)

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "taskId": "1758518400123456789",
    "status": "SUCCESS",
    "title": "作品标题",
    "content": "作品正文(作者发布的图文简介,部分作品可能为空)",
    "platform": "DOUYIN",
    "duration": 125,
    "textContent": "视频文案(译文)……",
    "sourceText": "视频原文案……",
    "videoUrl": "https://example.com/video.mp4",
    "workUrl": "https://v.douyin.com/xxxxxxxx/",
    "cover": "https://example.com/cover.jpg"
  }
}

duration 单位为秒;textContent 为译文文案,sourceText 为原文案;content 为作品正文(作者发布的图文简介,部分作品可能为空);videoUrl / cover 为无水印视频与封面地址,可能具有时效性。任务状态为文本:WAITING / SUCCESS / FAILURE。

POST

/image/task/create

创建图片文案提取任务

提交小红书 / 抖音图集作品链接,或直接提交图片链接列表,创建图片文案提取任务,返回用于轮询的 taskId。

请求参数

参数类型必填说明
typestring是任务类型:workUrl(作品链接)或 imageUrl(图片链接)
workUrlstringtype=workUrl 时必填小红书 / 抖音图集作品分享链接(仅支持小红书、抖音平台)
imageUrlsstring[]type=imageUrl 时必填图片链接列表,按图片张数扣减识别额度

请求示例(直接提交图片链接)

curl -X POST 'https://www.dousnap.com/prod-api/douchong-api/v1/image/task/create' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: your-api-key' \
  -H 'X-API-Secret: your-api-secret' \
  -d '{"type": "imageUrl", "imageUrls": ["https://example.com/image1.jpg", "https://example.com/image2.jpg"]}'

提交图集作品链接时改为:{"type": "workUrl", "workUrl": "https://www.xiaohongshu.com/explore/yyyyyyyy"}(仅支持小红书、抖音图集作品)。

响应示例

{
  "code": 200,
  "msg": "任务已提交",
  "data": {
    "taskId": "1758518400987654321",
    "status": "WAITING",
    "message": "任务已提交,处理中"
  }
}
GET

/image/task/query

查询图片任务状态与结果

按 taskId 查询图片文案提取任务进度;任务完成后返回每张图片的识别文案。处理中时可间隔数秒轮询。

请求参数

参数类型必填说明
taskIdstring是任务ID,创建图片任务时返回

请求示例

curl 'https://www.dousnap.com/prod-api/douchong-api/v1/image/task/query?taskId=1758518400987654321' \
  -H 'X-API-Key: your-api-key' \
  -H 'X-API-Secret: your-api-secret'

响应示例(任务完成)

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "type": "imageUrl",
    "status": 2,
    "taskId": "1758518400987654321",
    "content": null,
    "dataList": [
      {
        "id": 1,
        "status": 2,
        "content": "第一张图片识别文案……",
        "imageUrl": "https://example.com/image1.jpg"
      },
      {
        "id": 2,
        "status": 2,
        "content": "第二张图片识别文案……",
        "imageUrl": "https://example.com/image2.jpg"
      }
    ]
  }
}

注意:与视频任务的 WAITING / SUCCESS / FAILURE 文本状态不同,图片任务状态为数字——任务级 status:1=处理中,2=已完成;dataList 内每张图片 status:0=识别失败或超时(content 为失败原因),1=处理中,2=识别完成。content 为作品正文,仅 type=workUrl(图集作品链接)时返回,type=imageUrl 时为空;逐张图片的识别文案请读取 dataList。

GET

/quota/usage

查询转写时长用量

查询当前账号的转写时长额度与已用量,与站内「视频文案提取」共用同一时长池。

请求示例

curl 'https://www.dousnap.com/prod-api/douchong-api/v1/quota/usage' \
  -H 'X-API-Key: your-api-key' \
  -H 'X-API-Secret: your-api-secret'

响应示例

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "unlimited": false,
    "totalSeconds": 360000,
    "usedSeconds": 4200,
    "availableSeconds": 355800,
    "availableMinutes": "5930.0"
  }
}

unlimited 为 true 表示不限时长,此时秒数字段可能为空。图片文案提取额度与站内「图片文案提取」共用,可在站内「我的权益」查看。

GET

/quota/concurrency

查询并发额度占用

查询当前并发任务占用情况,与站内任务共用并发额度;canAddTask 为 false 时应先等待任务完成。

请求示例

curl 'https://www.dousnap.com/prod-api/douchong-api/v1/quota/concurrency' \
  -H 'X-API-Key: your-api-key' \
  -H 'X-API-Secret: your-api-secret'

响应示例

{
  "code": 200,
  "msg": "操作成功",
  "data": {
    "currentConcurrency": 3,
    "maxConcurrency": 20,
    "availableConcurrency": 17,
    "canAddTask": true
  }
}

权益与限制

  • 开放接口为旗舰版(Ultra)专属权益,其他套餐调用将返回 601,可在站内升级。
  • API 能力范围:目前仅支持「视频文案提取」与「图片文案提取」,其他站内功能暂不支持 API 调用。
  • API 转写时长与站内「视频文案提取」共用同一权益时长池,接口调用同样按视频时长扣减。
  • 图片文案提取按提交图片张数扣减识别额度,与站内「图片文案提取」共用权益;图片任务并发与站内图片识别并发共用额度。
  • API 任务并发与站内共用并发额度(旗舰版为 20),并发已满时请先等待任务完成。
  • 每个账号最多可创建 10 个 API Key;删除 Key 后使用该 Key 的调用会立即失败。
  • workUrl 需为支持平台的公开作品分享链接(抖音、小红书、快手、B站、TikTok 等),规则与站内提取一致;图片任务仅支持小红书、抖音图集作品。
  • 请妥善保管 API Secret,不要在前端页面、公开仓库等场景明文暴露。