获取图片预览链接。
GEThttps://www.aigei.com/open/api/v1/image/preview-downloadURL查询参数
| 参数名 | 中文名称 | 数据类型 | 必填 | 示例 | 取值约束 | 功能描述 | ||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
fileId |
文件编号 | string | 是 | "xPACzaFWLfJqiv6FRxsq7TmEIOJ38X" |
最短字符数:
1
最长字符数:
1024
|
取自同类资源搜索或详情的 prevImageList;原样传入所选记录的 fileId,仅限当前用户使用,不能使用正式文件编号或其他媒体预览编号。 |
||||||||
imageSize |
预览图片尺寸 | string | 否 | "mini" |
- | 水印预览图的尺寸档位,可选 mini、middle、large,缺省为 mini。
|
“必返”表示父对象存在且非 null 时必须返回的字段;可选字段可能省略,类型允许 null 时也可能返回 null。
| 参数名 | 中文名称 | 数据类型 | 必返 | 示例 | 取值约束 | 功能描述 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
requestId |
请求编号 | string / null | 是 | "f0f931dbaf264523a3ba018f44d0954a" |
- | 本次请求的编号,排查问题时请提供。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
code |
状态码 | string | 是 | "10001" |
- | 业务状态码;10001 表示成功,其他值表示失败。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
message |
状态说明 | string | 是 | "Success" |
- | 状态或错误说明;以 code 判断成功或失败。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
timeElapsed |
执行耗时 | string / null | 是 | "508ms" |
- | 请求耗时,单位毫秒,带 ms 后缀。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
fund |
实际扣费信息 | object | 否 | - |
仅支持已列字段
|
登录用户预览或文件下载成功后的实际费用与账户余额;查询、游客调用及失败时省略。 |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 参数名 | 中文名称 | 数据类型 | 必返 | 示例 | 取值约束 | 功能描述 | ||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
fundNotice |
消耗说明 | string | 是 | "Free" |
- | 本次费用说明。
|
||||||
fundType |
资金类型 | string | 是 | "down" |
可选值:
["down"]
|
下载实际扣费币种,down 为铜币。 |
||||||
fundValue |
资金消耗 | number | 是 | 0 |
最小值:
0
|
本次实际扣费金额。 |
||||||
fundBalance |
对应账户余额 | number | 是 | 100 |
- | 调用完成后的账户余额,币种与 fundType 一致。 |
data{ … }成功时返回预览文件及链接,失败时为null。
data · 业务数据 · 对象子属性| 参数名 | 中文名称 | 数据类型 | 必返 | 示例 | 取值约束 | 功能描述 | |||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
fileId |
文件编号 | string | 是 | "xPACzaFWLfJqiv6FRxsq7TmEIOJ38X" |
最短字符数:
1
最长字符数:
1024
|
本次请求使用的预览文件编号。 |
|||||||||||||||||||||||||||||||||||
fileType |
文件类型 | string | 是 | "image" |
- | 固定为 image,返回本次水印预览图的 imageSize 和 imageProperties。
|
|||||||||||||||||||||||||||||||||||
fileExtName |
文件扩展名 | string | 是 | "jpg" |
- | 实际交付文件的扩展名,不带点。 |
|||||||||||||||||||||||||||||||||||
imageSize |
预览图片尺寸 | string | 否 | "mini" |
- | 实际返回的图片尺寸档位,默认 mini;仅图片返回。
|
|||||||||||||||||||||||||||||||||||
fileDownloadUrl |
下载地址 | string | 是 | "https://example.com/open-api/previews/image.jpg?e=1792531200&token=example-signature" |
- | 预览文件下载链接。下载链接限时有效,请及时下载;失效后需重新获取。 |
|||||||||||||||||||||||||||||||||||
fileSizeMb |
预览文件大小 | number / null | 否 | 0.5 |
最小值:
0
|
动态生成的水印预览图不提供文件大小,此字段省略。 |
|||||||||||||||||||||||||||||||||||
imageProperties |
实际输出图片尺寸 | object | 否 | { … } |
仅支持已列字段
|
本次水印预览图实际输出的宽高,已包含所选尺寸档位的缩放结果。 |
|||||||||||||||||||||||||||||||||||
|
|||||||||||||||||||||||||||||||||||||||||
| 参数名 | 中文名称 | 数据类型 | 必返 | 示例 | 取值约束 | 功能描述 |
|---|---|---|---|---|---|---|
format |
文件格式 | string | 否 | "png" |
- | 当前文件的格式。 |
imageWidthPx |
图片宽度 | integer / null | 否 | 198 |
- | 当前图片文件的宽度,单位像素。 |
imageHeightPx |
图片高度 | integer / null | 否 | 132 |
- | 当前图片文件的高度,单位像素。 |
transparent |
是否透明 | boolean | 否 | true |
- | 是否包含透明或半透明像素;true 表示包含,false 表示不包含,未知时省略。 |
示例仅供参考;调用时请使用当前用户获取的编号和链接。
本次水印预览图的链接、尺寸档位及实际输出宽高,不包含音频或视频属性;费用信息见外层 fund。
图片预览下载(图片缺省mini)
GET https://www.aigei.com/open/api/v1/image/preview-download?fileId=xPACzaFWLfJqiv6FRxsq7TmEIOJ38X
Authorization: Bearer <API_KEY>
mini水印图片
GET https://www.aigei.com/open/api/v1/image/preview-download?fileId=xPACzaFWLfJqiv6FRxsq7TmEIOJ38X&imageSize=mini
Authorization: Bearer <API_KEY>
middle水印图片
GET https://www.aigei.com/open/api/v1/image/preview-download?fileId=xPACzaFWLfJqiv6FRxsq7TmEIOJ38X&imageSize=middle
Authorization: Bearer <API_KEY>
large水印图片
GET https://www.aigei.com/open/api/v1/image/preview-download?fileId=xPACzaFWLfJqiv6FRxsq7TmEIOJ38X&imageSize=large
Authorization: Bearer <API_KEY>
以下为结构示例,文件编号、下载地址、耗时及费用均以实际调用结果为准;example.com 地址仅用于说明链接格式。
{
"requestId" : "preview-example",
"code" : "10001",
"message" : "Success",
"fund" : {
"fundNotice" : "Free",
"fundType" : "down",
"fundValue" : 0,
"fundBalance" : 5000
},
"timeElapsed" : "508ms",
"data" : {
"fileId" : "xPACzaFWLfJqiv6FRxsq7TmEIOJ38X",
"fileType" : "image",
"fileExtName" : "jpg",
"imageSize" : "mini",
"imageProperties" : {
"imageWidthPx" : 198,
"imageHeightPx" : 132
},
"fileDownloadUrl" : "https://example.com/open-api/previews/image.jpg?e=1792531200&token=example-signature"
}
}