Skip to main content
POST
Export a video or versioned chat sticker

Authorizations

X-Api-Key
string
header
required

API key with format vbr_ followed by 32 characters

Path Parameters

id
string
required

Body

application/json

Select a versioned sticker format or a generic format. Sticker formats own dimensions and duration and reserve 10 percent size headroom. Use sticker-telegram-v1, sticker-whatsapp-v1, sticker-wechat-v1 or sticker-discord-v1 in format. The legacy sticker_profile input remains accepted. Generic exports retain the existing format/transform/options interface.

sticker_profile
enum<string>
required
deprecated

Legacy input. Prefer the versioned sticker format in format.

Available options:
telegram-v1,
whatsapp-v1,
wechat-v1,
discord-v1
format
enum<string>
Available options:
sticker-telegram-v1,
sticker-whatsapp-v1,
sticker-wechat-v1,
sticker-discord-v1,
webm_vp9,
hevc_alpha,
mov_prores,
stacked_video,
png_sequence,
pro_bundle,
stacked_video_mask_inverted,
mask_video,
mask_video_inverted,
gif,
webp,
apng,
lottie,
dotlottie,
color,
blur,
original
use_gpu
boolean
default:true

Send false for CPU sticker exports. The same profiles work inside GPU batches.

mask_version
integer
Required range: x >= 1
webhook_url
string<uri>
transform
object

Profiles support crop, reverse and fps; omit max_width.

options
object
background
object
blur
object

Response

200

Queued export receipt; poll GET /v1/exports/{exportId} for validation and a download.