跳到主要内容

指定人物添加特征图片

1. 请求

1.1 请求地址

区域请求地址
国内https://api.open.tuputech.com/v3/management/person-feature/create/url/<secretId>
提示

<secretId> 需替换为您的应用 SID,请联系客户经理为您开通及配置。关于 SID 详见 常见问题(FAQ)

1.2 请求方法

POST

1.3 请求头

请求头名称取值是否必需示例说明
Content-Typeapplication/jsonContent-Type: application/json请求数据类型为 JSON
X-API-Key<API Key>X-API-Key: <API Key>API Key 用于接口鉴权。请访问控制台 - 数字证书 获取 API Key
危险

由于模型基于请求流量动态伸缩,在空闲一定时间后会关闭(部分专用模型空闲一定时间后会关闭全部实例)。 由于模型冷启动耗时较长,部分请求可能无法处理,最终返回非 200 HTTP 状态码或业务状态码 101。该现象可能在以下情况下出现:

  • 初次请求
  • 长时间未调用后再次请求
  • 请求流量突增
  • 请求存在规律性的流量波动(例如每隔超过 5 分钟请求一批数据,或仅在工作日期间有大量请求)

针对以上情况,我们分别建议您:

  • 间隔 2~3 分钟后重试
  • 间隔 2~3 分钟后重试,并且后续保持至少每分钟 1 次调用
  • 提前进行预热,或及时联系我们扩容
  • 调整业务请求时间间隔到 5 分钟内,或联系我们调整实例保持策略。若您的业务仅在工作日期间有大量请求,节假日期间较少,请务必联系我们

1.4 请求参数

参数名称类型是否必需说明
personIdString人物 ID
personLibraryIdString人物名单 ID
imagesArray<Image>待增加的图片数组,数量应小于 1,00, 建议控制一次入库图片的总大小不超过 100M,过大将导致 413 Request Entity Too Large 。参数详见 image 参数说明
versionString指定抽人脸特征模型版本和特征库版本号(v5/v6)。默认 v5。v5 版本模型已经停止位维护,请联系运营更新自定义名单库识别模型和把旧特征库转换新特征库上
similarityLimitOfPersonFloat取值范围 [0-100],例如 80,如果同一人物 ID,特征相似度大于 80,拒绝入库。默认不限制。只有相同图片拒绝入库。
timestampInt当前服务器的 Unix 时间戳。

当前已废弃,仅保持兼容(采用该鉴权方式的调用不受影响)。新接入请使用 API Key 接口鉴权
nonceFloat随机数(建议使用 Unix 时间戳或若干位随机整数)。

当前已废弃,仅保持兼容(采用该鉴权方式的调用不受影响)。新接入请使用 API Key 接口鉴权
signatureString

RSA-SHA256 算法签名。

当前已废弃,仅保持兼容(采用该鉴权方式的调用不受影响)。新接入请使用 API Key 接口鉴权。

签名步骤:

  1. 将参与签名的参数(secretIdtimestampnonce)用英文半角逗号 , 拼接,得到 SignString
  2. 使用您的私钥以 RSA-SHA256 算法对 SignString 签名,然后进行 Base64 编码,得到 signature 字符串。
  • 点击 数字证书 下载私钥。私钥有 rsapkcs8 两种格式,通常 Golang,Python 使用 rsa 格式私钥,Java 使用 pkcs8 格式私钥
  • 点击 签名及验证示例 查看签名示例

Image 参数说明

参数名称类型是否必需说明
nameString图片名称
urlString图片链接

1.5 请求示例

{
"personId": "<personId>",
"personLibraryId": "<personLibraryId>",
"version": "<version>",
"timestamp": "<timestamp>",
"nonce": "<nonce>",
"signature": "<signature>",
"images": [
{
"name": "name1",
"url": "https://www.tuputech.com/fake.jpg"
}
]
}

2. 响应

2.1 响应内容

参数名称类型说明
jsonString响应内容 JSON 转义后的字符串
signatureString响应内容签名

2.2 响应参数

参数名称类型是否可能为空说明
codeInt状态码
nonceFloat随机数(建议使用 Unix 时间戳或若干位随机整数)
messageString相关信息
timestampInt时间戳
featureArray<Feature>图片信息,详见 Feature 结果详情

Feature 结果详情

参数名称类型是否可能为空说明
codeInt状态码,标识该图片是否成功入库,详见公共服务状态码
errorString错误原因
nameString图片名称
urlString图片链接
person_IdString人物 id
feature_idString特征 ID

2.3 响应示例

{
"code": 0,
"feature": [
{
"code": 0,
"error": "",
"person_id": "xxx",
"name": "xxx.jpeg",
"url": "xxx",
"feature_id": "xxx"
}
],
"message": "success",
"nonce": 0.7425908573712917,
"timestamp": 1691729352
}

3. 更新日志

日期说明
2025-06-17新增 API Key 接口鉴权方式,简化接口鉴权。废弃签名鉴权方式,仅保持兼容(采用签名鉴权方式的调用不受影响)