应用关联的人物名单信息查询

1. 请求

1.1 请求地址

区域	请求地址
国内	https://api.open.tuputech.com/v3/management/person-library/search/<secretId>

提示

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

1.2 请求方法

POST

1.3 请求头

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

1.4 请求参数

参数名称	类型	是否必需	说明
name	String	否	人物名单名称，模糊搜索
timestamp	Int	否	当前服务器的 Unix 时间戳。 当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权
nonce	Float	否	随机数（建议使用 Unix 时间戳或若干位随机整数）。 当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权
signature	String	否	RSA-SHA256 算法签名。 当前已废弃，仅保持兼容（采用该鉴权方式的调用不受影响）。新接入请使用 API Key 接口鉴权。 签名步骤： 将参与签名的参数（secretId，timestamp，nonce）用英文半角逗号 , 拼接，得到 SignString； 使用您的私钥以 RSA-SHA256 算法对 SignString 签名，然后进行 Base64 编码，得到 signature 字符串。 点击 数字证书 下载私钥。私钥有 rsa 和 pkcs8 两种格式，通常 Golang，Python 使用 rsa 格式私钥，Java 使用 pkcs8 格式私钥 点击 签名及验证示例 查看签名示例

1.5 请求示例

{
  "name": "<name>",
  "timestamp": "<timestamp>",
  "nonce": "<nonce>",
  "signature": "<signature>"
}

2. 响应

2.1 响应内容

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

2.2 响应参数

参数名称	类型	是否可能为空	说明
code	Int	否	状态码
nonce	Float	否	随机数（建议使用 Unix 时间戳或若干位随机整数）
message	String	否	相关信息
timestamp	Int	否	时间戳
personLibrary	Array<PersonLibary>	否	名单信息，详见 PersonLibary 说明

PersonLibary 说明

参数名称	类型	是否可能为空	说明
id	String	否	人物名单 id
name	String	否	人物名单名称
priority	Int	否	优先级
secretIds	Array<String>	否	关联的 secretId
features	Int	否	关联的特征数

2.3 响应示例

 {
    "code": 0,
    "message": "success",
    "nonce": 0.24965500730361836,
    "personLibrary": [
        {
            "id": "xxxx",
            "name": "测试人物库",
            "priority": 1,
            "secretIds": ["xxxx", "yyyy"],
            "features": 10,
        }
    ],
    "timestamp": 1691719001
}

3. 更新日志

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