跳转到内容

工具与积分余额

查询可用处理工具、参数选项、媒体限制与当前账户的积分余额。

选择 toolId 和 params 前先读取目录。返回值包含图片与视频工具、水印辅助工具、参数类型、媒体限制与当前价格。是否能处理还取决于输入素材和可用算力,不能把一种参数类型用于所有工具。

例如 image-sr 使用 {"type":"scale","value":2} 进行图片 2 倍超分。使用其他倍数前先查询返回的选项。视频超分使用 video-sr,同样需要根据输入与参数重新报价。

GET/api/v1/tools
Bearer API Key权限: read成功: 200

调用示例

Terminal window
curl --include --fail-with-body --silent --show-error --max-time 60 \
--request GET 'https://app.berserkapi.com/api/v1/tools' \
--header "Authorization: Bearer $GLACIER_API_KEY"
响应字段 · 200
animatedboolean必填

能处理动图(多帧的 GIF / WebP / APNG / AVIF):每一帧都处理,产物沿用原格式;为 false 的图片工具不接受动图

animatedPriceobject必填

处理动图的价格(积分):bands 是每帧的价格(按每帧的输出像素分档),消耗 = max(minCredits, 所在档 × 帧数);null 表示不处理动图或暂未开放

展开字段 / 类型
bandsobject[]必填

按输出像素分档的每次价格(像素上限递增);为空表示不分档

展开字段 / 类型
creditsinteger · int64必填

这一档每次的积分

minimum: 0 · maximum: 10000000

maxPixelsinteger · int64必填

这一档输出像素(宽 × 高)的上限

minimum: 1 · maximum: 1000000000

fixedCreditsinteger · int64必填

每任务固定费(积分);整单费用不低于 minCredits

minCreditsinteger · int64必填
unitCreditsinteger · int64必填
unitDivisorinteger · int64必填

单价分母,实际单价为 unitCredits / unitDivisor;用整数精确表达小数价格

unitSizeinteger · int64必填

每计量单位的像素或像素帧数;0 表示沿用默认 U,图片为1600万像素、视频为62208000像素帧

billing"fixed" | "work"必填
descriptionstring必填
group"enhance" | "restore" | "detect"必填
idstring必填
kind"image" | "video"必填
limitsobject必填

对处理后画面的上限(超分按放大后的尺寸计算;时长、帧数按输入计算),超限的任务会被拒绝

展开字段 / 类型
maxAspectinteger · int64必填

长边 / 短边上限

maxBytesinteger · int64必填

文件大小上限(字节)

maxDurationMsinteger · int64必填

视频时长上限(毫秒)

maxFrameRateinteger · int64必填

视频帧率上限(帧/秒)

maxFramesinteger · int64必填

视频帧数上限

maxPixelsinteger · int64必填

总像素(宽 × 高)上限

maxSideinteger · int64必填

长边上限(像素)

minSideinteger · int64必填

短边下限(像素)

namestring必填
paramobject | object | object | object | object必填
展开字段 / 类型
类型 1 · object
type"none"必填
类型 2 · object
defaultinteger · int64必填
optionsinteger · int64[]必填
展开字段 / 类型

integer · int64

smallInputMaxPixelsinteger · int64必填
smallInputMaxSideinteger · int64必填
type"scale"必填
类型 3 · object
defaultinteger · int64必填
optionsinteger · int64[]必填
展开字段 / 类型

integer · int64

type"fps"必填
类型 4 · object
defaultboolean必填
type"faceProtect"必填
类型 5 · object
maxRegionsinteger · int64必填
type"regions"必填
priceobject必填

当前价格(积分);null 表示暂未开放。实际消耗以 quoteTask 为准

展开字段 / 类型
bandsobject[]必填

按输出像素分档的每次价格(像素上限递增);为空表示不分档

展开字段 / 类型
creditsinteger · int64必填

这一档每次的积分

minimum: 0 · maximum: 10000000

maxPixelsinteger · int64必填

这一档输出像素(宽 × 高)的上限

minimum: 1 · maximum: 1000000000

fixedCreditsinteger · int64必填

每任务固定费(积分);整单费用不低于 minCredits

minCreditsinteger · int64必填
unitCreditsinteger · int64必填
unitDivisorinteger · int64必填

单价分母,实际单价为 unitCredits / unitDivisor;用整数精确表达小数价格

unitSizeinteger · int64必填

每计量单位的像素或像素帧数;0 表示沿用默认 U,图片为1600万像素、视频为62208000像素帧

钱包返回当前账户的积分余额与即将到期的积分信息。网页与 API 任务共用这份余额,只读密钥也可查询。积分使用整数单位,不随文档语言切换改变;准确的处理消耗请通过任务报价获取。

GET/api/v1/wallet
Bearer API Key权限: read成功: 200

调用示例

Terminal window
curl --include --fail-with-body --silent --show-error --max-time 60 \
--request GET 'https://app.berserkapi.com/api/v1/wallet' \
--header "Authorization: Bearer $GLACIER_API_KEY"
响应字段 · 200
balanceCreditsinteger · int64必填

积分余额(含未到期的赠送积分)

giftCreditsinteger · int64必填

其中未到期的赠送积分(扣除时先扣)

giftExpiresAtstring | null · date-time必填

最早一批赠送积分的到期时间;没有赠送积分时为 null

giftExpiringCreditsinteger · int64必填

最早到期的那一批还剩的积分

purchasedCreditsinteger · int64必填
subscriptionCreditsinteger · int64必填
subscriptionExpiresAtstring | null · date-time必填
subscriptionExpiringCreditsinteger · int64必填

图片包余额、免加急次数、已购期限与当前套餐由后端统一返回。网页与 API 共用额度。报价与创建任务可传 useImagePack: true 或 rush: true;图片包仅支持增强静态图片超分,不能与加急同时使用。失败和取消会退回原周期额度,过期额度不会延长。

GET/api/v1/benefits
Bearer API Key权限: read成功: 200

调用示例

Terminal window
curl --include --fail-with-body --silent --show-error --max-time 60 \
--request GET 'https://app.berserkapi.com/api/v1/benefits' \
--header "Authorization: Bearer $GLACIER_API_KEY"
响应字段 · 200
concurrencyinteger · int64必填
imagesRemaininginteger · int64必填
maxVideoMinutesinteger · int64必填
paidPlanboolean必填
periodEndsAtstring | null · date-time必填
planIdstring必填
retentionDaysinteger · int64必填
rushesRemaininginteger · int64必填
storageGBinteger · int64必填
subscriptionsobject[]必填
展开字段 / 类型
endsAtstring · date-time必填
idstring必填
planIdstring必填
startsAtstring · date-time必填
topupBonusPercentinteger · int64必填