图片识别
把图片网址交给这个接口,返回图片上读到的 JSON。多个网址用英文逗号隔开。下面的密钥写成 xxxxx,换成你自己的密钥。
地址
调用方式可以是 POST,也可以是 GET。
POST https://jk.coolyou.vip/v1/open/items GET https://jk.coolyou.vip/v1/open/items
请求头
Authorization 用来证明是哪一个调用方。写成 Authorization: Bearer xxxxx。Bearer 是固定词,xxxxx 换成密钥,中间有一个空格。密钥只放在这里,不要放进网址参数。
Content-Type 说明正文的格式。POST 要把图片网址放进 JSON,所以写成 Content-Type: application/json。GET 没有正文,这一项可以不带。
X-Request-Id 是这一次请求的编号,可选。你自己编一个,例如 order-1001。接口在响应头里原样带回同一个编号,方便对上是哪一次调用。不填时,接口会自己生成一个。
Authorization: Bearer xxxxx Content-Type: application/json X-Request-Id: order-1001
调用代码
curl。xxxxx 换成密钥。两个网址用英文逗号隔开。
curl -X POST 'https://jk.coolyou.vip/v1/open/items' \
-H 'Authorization: Bearer xxxxx' \
-H 'Content-Type: application/json' \
-H 'X-Request-Id: order-1001' \
-d '{"image_url":"https://cdn.example.com/a.png,https://cdn.example.com/b.png"}'
JavaScript。
await fetch('https://jk.coolyou.vip/v1/open/items', {
method: 'POST',
headers: {
Authorization: 'Bearer xxxxx',
'Content-Type': 'application/json',
'X-Request-Id': 'order-1001',
},
body: JSON.stringify({
image_url: 'https://cdn.example.com/a.png,https://cdn.example.com/b.png',
}),
});
一个网址
{
"image_url": "https://cdn.example.com/a.png"
}
GET 写成 ?image_url=https://cdn.example.com/a.png
多个网址
用英文逗号隔开,一次最多 5 张。前后多出来的说明会被拿掉,只留网址。中文逗号后面又是一个网址时,同样会拆开。网址参数里的逗号留在同一个网址里。这几张图同时下载,下完一张就把图片内容交给模型,读完就从内存丢掉,不留文件。单张不超过 8MB。
{
"image_url": "https://cdn.example.com/a.png,https://cdn.example.com/b.png"
}
返回
成功时 HTTP 200,正文是一个 JSON 数组,没有 code。一张图也是只含一项的数组。多张图按网址顺序放进同一个数组,成功的项是这张图的 JSON,失败的项是这张图自己的 code、error 和 index。一张失败不会停掉其他张,也不会把整次变成一条错误。
[{"item_power":800}]
[{"item_power":800},{"code":5021,"error":"第2个读图失败,请稍后再试","index":2}]
错误码
整次失败时正文是 code 和 error,只有一张图读失败时也是这种正文。多张图时 HTTP 仍是 200,失败的那一项里用同样的 code 和 error,并带 index,从 1 开始。地址过多或不规范时,还没开始读图,整次直接返回错误。
{"code":4003,"error":"图片地址无图片可读"}
| code | HTTP | 含义 |
|---|---|---|
4001 | 400 | 图片地址过多。一次超过 5 个。不重试。 |
4002 | 400 | 图片地址不规范。不是公网 https。不重试。 |
4003 | 422 | 图片地址无图片可读,或单张超过 8MB。确认不是图片、以及超过大小的,不重试。 |
4004 | 502 | 图片分析无结果。空对象、空数组、值全空,都算。只重试这一张。 |
4005 | 502 | 图片分析的内容不是 JSON。只重试这一张。 |
4006 | 400 | 密钥放在网址参数里。 |
4011 | 401 | 没有带 Bearer 密钥。 |
4012 | 401 | 密钥不正确。 |
4031 | 403 | 密钥已停用。 |
4032 | 403 | 这种调用方式已关闭。 |
4033 | 403 | 来源地址不在这把密钥的白名单。白名单按密钥和接口分开绑,这把密钥没绑规则时不限制。 |
4034 | 403 | 来源域名不在这把密钥的白名单。域名看请求的 Origin 或 Referer。 |
4291 | 429 | 这一把密钥这一分钟的次数已用完。 |
4292 | 429 | 这一把密钥同时读取已满。 |
5021 | 502 | 读图失败。只重试这一张。 |
5031 | 503 | 识别模型还没选。 |
5041 | 504 | 读图超时。只重试这一张。 |
会重试的错误,当前再试 1 次。图片地址过多、不规范,以及已经确认没有图片的,不再试。
接口测试
先选择开放接口,再填这一项要测的内容。密钥只留在这次请求里,页面不保存。白名单如果绑了 IP,这里用的是你当前电脑的地址。如果绑了域名,浏览器带来的域名是这个接口自己的域名,对不上调用方网站。