图片文案提取 API 文档
包含「提交图片文案提取任务」与「查询图片文案提取任务」两项接口说明
基础信息
Base URL:https://api.anytocopy.com/vip/open-api/v1
如你的网关未使用 /prod-api 前缀,请将 Base URL 调整为实际可访问地址。
提交任务
POST https://api.anytocopy.com/vip/open-api/v1/image/ocr/doTask
查询任务
GET https://api.anytocopy.com/vip/open-api/v1/image/ocr/queryTask
支持两种输入方式
- type=workUrl:传入抖音/小红书作品链接,由系统自动解析图片并执行 OCR。
- type=imageUrl:直接传入图片 URL 列表,对每张图片进行文案提取。
鉴权请求头(Header)
Content-Type: application/json
X-API-Key: your_api_key
X-API-Secret: your_api_secret 提交图片文案提取任务
使用 JSON 请求体提交任务,成功后返回 taskId,后续通过查询接口轮询结果。
Endpoint
https://api.anytocopy.com/vip/open-api/v1/image/ocr/doTask
请求头
- Content-Type:application/json
- X-API-Key:你的 API Key
- X-API-Secret:你的 API Secret
| 字段 | 类型 | 必填 | 说明 |
|---|---|---|---|
| type | String | 是 | 任务类型,可选值:workUrl、imageUrl |
| workUrl | String | 条件必填 | 当 type=workUrl 时必填,当前支持抖音、小红书作品链接 |
| imageUrls | Array<String> | 条件必填 | 当 type=imageUrl 时必填,传入待识别的图片 URL 列表 |
接入说明
- 按作品链接识别时,系统会先解析作品中的图片,再执行 OCR。
- 按图片 URL 列表识别时,会按图片张数做权益校验与扣减。
- 接口采用异步任务模式,提交成功后不会直接返回完整识别结果。
curl 示例:按作品链接识别
curl -X POST 'https://api.anytocopy.com/vip/open-api/v1/image/ocr/doTask' \
-H 'Content-Type: application/json' \
-H 'X-API-Key: your_api_key' \
-H 'X-API-Secret: your_api_secret' \
-d '{
"type": "workUrl",
"workUrl": "https://www.xiaohongshu.com/explore/xxxxxxxx"
}'curl 示例:按图片 URL 列表识别
curl -X POST 'https://api.anytocopy.com/vip/open-api/v1/image/ocr/doTask' \
-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/image-1.jpg",
"https://example.com/image-2.jpg"
]
}'响应示例
1. 提交成功
{
"code": 200,
"msg": "任务已提交",
"data": "1925812345678901234"
}2. 鉴权失败
{
"code": 401,
"msg": "API Key验证失败,请检查Key和Secret是否正确,或是否已过期/禁用"
}3. 权益不足
{
"code": 601,
"msg": "图片文案提取剩余可用次数不足!本次需要2张图片,剩余1张,请升级会员后重试~"
}4. 并发超限
{
"code": 500,
"msg": "您的并发任务已达上限(2/2),请等待任务完成后再试"
}5. 参数错误
{
"code": 500,
"msg": "任务类型不能为空"
} 查询图片文案提取任务
根据 taskId 查询任务状态。当状态为 2 时,可读取完整识别结果列表。
Endpoint
https://api.anytocopy.com/vip/open-api/v1/image/ocr/queryTask
请求参数
- taskId:提交任务成功后返回的任务 ID
任务状态:1 表示处理中,2 表示已完成。
curl 示例
curl -X GET 'https://api.anytocopy.com/vip/open-api/v1/image/ocr/queryTask?taskId=1925812345678901234' \
-H 'X-API-Key: your_api_key' \
-H 'X-API-Secret: your_api_secret'响应示例
1. 处理中(部分结果可能已返回)
{
"code": 200,
"msg": "操作成功",
"data": {
"type": "imageUrl",
"status": 1,
"taskId": "1925812345678901234",
"title": null,
"workUrl": null,
"content": null,
"dataList": [
{
"id": 101,
"status": 2,
"content": "图片一识别出的文案内容",
"imageUrl": "https://example.com/image-1.jpg"
},
{
"id": 102,
"status": 1,
"content": "",
"imageUrl": "https://example.com/image-2.jpg"
}
]
}
}2. 处理完成
{
"code": 200,
"msg": "操作成功",
"data": {
"type": "imageUrl",
"status": 2,
"taskId": "1925812345678901234",
"title": null,
"workUrl": null,
"content": null,
"dataList": [
{
"id": 101,
"status": 2,
"content": "图片一识别出的文案内容",
"imageUrl": "https://example.com/image-1.jpg"
},
{
"id": 102,
"status": 2,
"content": "图片二识别出的文案内容",
"imageUrl": "https://example.com/image-2.jpg"
}
]
}
}3. 无权查询该任务
{
"code": 500,
"msg": "无权查询该任务"
}响应状态码说明
| 状态码 | 说明 | 场景 |
|---|---|---|
| 200 | 请求成功 | 任务提交成功或查询成功 |
| 401 | 鉴权失败 | API Key / Secret 缺失、错误、已过期或已禁用 |
| 500 | 业务失败 | 并发超限、链接不支持、参数错误、无权查询等 |
| 601 | 权益不足 | 图片文案提取剩余次数不足 |
任务状态说明
| 状态值 | 说明 | 处理建议 |
|---|---|---|
| 1 | 处理中 | 建议每隔 1-3 秒轮询一次,可接受部分已完成图片的结果 |
| 2 | 已完成 | 读取 data.dataList 中所有识别结果 |
响应字段说明
| data 字段 | 类型 | 说明 |
|---|---|---|
| type | String | 任务类型:workUrl / imageUrl |
| status | Integer | 任务状态:1 处理中,2 已完成 |
| taskId | String | 任务 ID |
| title | String | 当 type=workUrl 时,可能返回作品标题 |
| workUrl | String | 当 type=workUrl 时返回作品链接 |
| content | String | 当 type=workUrl 时,可能返回作品原始文案 |
| dataList | Array | 图片 OCR 识别结果列表 |
| dataList 子项字段 | 类型 | 说明 |
|---|---|---|
| id | Integer | 图片识别子任务 ID |
| status | Integer | 子任务状态,通常与整体任务进度一致 |
| content | String | 识别出的图片文案内容 |
| imageUrl | String | 原始图片地址 |
业务规则说明
- 1. 仅支持专业版会员调用,非专业版会员会直接返回失败。
- 2. 单用户存在并发任务限制,达到上限后无法继续提交新任务。
- 3. 图片文案提取按图片数量进行权益校验与扣减,权益不足时返回 601。
- 4. 只能查询当前 API Key 所属用户自己创建的任务,查询他人任务会返回“无权查询该任务”。
接口使用流程
推荐的接口调用流程和最佳实践
1
调用 POST /image/ocr/doTask 提交任务,选择按作品链接或图片 URL 列表识别。
2
从返回结果中获取 taskId,用于后续轮询任务状态。
3
每隔 1-3 秒 调用 GET /image/ocr/queryTask 查询任务结果。
4
当任务 status=2 时,读取 data.dataList 中的全部识别内容并保存业务结果。