Skip to content

Tools & credits

Discover processing tools, parameter choices, media limits and the current account balance.

Read the catalog before choosing toolId and params. It includes image/video tools, watermark helpers, supported parameter variants, media limits and current prices. Availability can depend on the source media and available compute. Do not infer that every parameter variant works with every tool.

For example, image-sr uses {"type":"scale","value":2} for 2× upscaling. Read the returned parameter choices before using a different factor. Video upscaling uses video-sr; get a fresh quote for its source and parameters.

GET/api/v1/tools
Bearer API KeyScope: readSuccess: 200

Request example

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"
Response fields · 200
animatedbooleanrequired
animatedPriceobjectrequired
Expand fields / variants
bandsobject[]required
Expand fields / variants
creditsinteger · int64required

minimum: 0 · maximum: 10000000

maxPixelsinteger · int64required

minimum: 1 · maximum: 1000000000

fixedCreditsinteger · int64required
minCreditsinteger · int64required
unitCreditsinteger · int64required
unitDivisorinteger · int64required
unitSizeinteger · int64required
billing"fixed" | "work"required
descriptionstringrequired
group"enhance" | "restore" | "detect"required
idstringrequired
kind"image" | "video"required
limitsobjectrequired
Expand fields / variants
maxAspectinteger · int64required
maxBytesinteger · int64required
maxDurationMsinteger · int64required
maxFrameRateinteger · int64required
maxFramesinteger · int64required
maxPixelsinteger · int64required
maxSideinteger · int64required
minSideinteger · int64required
namestringrequired
paramobject | object | object | object | objectrequired
Expand fields / variants
Variant 1 · object
type"none"required
Variant 2 · object
defaultinteger · int64required
optionsinteger · int64[]required
Expand fields / variants

integer · int64

smallInputMaxPixelsinteger · int64required
smallInputMaxSideinteger · int64required
type"scale"required
Variant 3 · object
defaultinteger · int64required
optionsinteger · int64[]required
Expand fields / variants

integer · int64

type"fps"required
Variant 4 · object
defaultbooleanrequired
type"faceProtect"required
Variant 5 · object
maxRegionsinteger · int64required
type"regions"required
priceobjectrequired
Expand fields / variants
bandsobject[]required
Expand fields / variants
creditsinteger · int64required

minimum: 0 · maximum: 10000000

maxPixelsinteger · int64required

minimum: 1 · maximum: 1000000000

fixedCreditsinteger · int64required
minCreditsinteger · int64required
unitCreditsinteger · int64required
unitDivisorinteger · int64required
unitSizeinteger · int64required

The wallet reports the current account’s credit balance and expiring credit information. Both web and API tasks spend from this balance. A read-only key can access it. Credits are integer units; they do not change when you switch the documentation language. Query the task quote for an exact processing cost.

GET/api/v1/wallet
Bearer API KeyScope: readSuccess: 200

Request example

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"
Response fields · 200
balanceCreditsinteger · int64required
giftCreditsinteger · int64required
giftExpiresAtstring | null · date-timerequired
giftExpiringCreditsinteger · int64required
purchasedCreditsinteger · int64required
subscriptionCreditsinteger · int64required
subscriptionExpiresAtstring | null · date-timerequired
subscriptionExpiringCreditsinteger · int64required

Query your Image Pack balance, free rush allowance, purchased terms and current plan. Web and API requests share these allowances. Pass useImagePack: true or rush: true when quoting and creating a task. Image Pack supports enhanced static image upscaling and cannot be combined with rush processing. Failed and cancelled jobs return allowances to their original period without extending expiry.

GET/api/v1/benefits
Bearer API KeyScope: readSuccess: 200

Request example

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"
Response fields · 200
concurrencyinteger · int64required
imagesRemaininginteger · int64required
maxVideoMinutesinteger · int64required
paidPlanbooleanrequired
periodEndsAtstring | null · date-timerequired
planIdstringrequired
retentionDaysinteger · int64required
rushesRemaininginteger · int64required
storageGBinteger · int64required
subscriptionsobject[]required
Expand fields / variants
endsAtstring · date-timerequired
idstringrequired
planIdstringrequired
startsAtstring · date-timerequired
topupBonusPercentinteger · int64required