Export a video or versioned chat sticker
curl --request POST \
--url https://api.videobgremover.com/v1/jobs/{id}/exports \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"use_gpu": true,
"mask_version": 2,
"webhook_url": "<string>",
"transform": {},
"options": {},
"background": {},
"blur": {}
}
'const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
use_gpu: true,
mask_version: 2,
webhook_url: '<string>',
transform: {},
options: {},
background: {},
blur: {}
})
};
fetch('https://api.videobgremover.com/v1/jobs/{id}/exports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.videobgremover.com/v1/jobs/{id}/exports"
payload = {
"use_gpu": True,
"mask_version": 2,
"webhook_url": "<string>",
"transform": {},
"options": {},
"background": {},
"blur": {}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)Export a video or versioned chat sticker
POST
/
v1
/
jobs
/
{id}
/
exports
Export a video or versioned chat sticker
curl --request POST \
--url https://api.videobgremover.com/v1/jobs/{id}/exports \
--header 'Content-Type: application/json' \
--header 'X-Api-Key: <api-key>' \
--data '
{
"use_gpu": true,
"mask_version": 2,
"webhook_url": "<string>",
"transform": {},
"options": {},
"background": {},
"blur": {}
}
'const options = {
method: 'POST',
headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
use_gpu: true,
mask_version: 2,
webhook_url: '<string>',
transform: {},
options: {},
background: {},
blur: {}
})
};
fetch('https://api.videobgremover.com/v1/jobs/{id}/exports', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.videobgremover.com/v1/jobs/{id}/exports"
payload = {
"use_gpu": True,
"mask_version": 2,
"webhook_url": "<string>",
"transform": {},
"options": {},
"background": {},
"blur": {}
}
headers = {
"X-Api-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)Authorizations
API key with format vbr_ followed by 32 characters
Path Parameters
Body
application/json
- Option 1
- Option 2
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.
Legacy input. Prefer the versioned sticker format in format.
Available options:
telegram-v1, whatsapp-v1, wechat-v1, discord-v1 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 Send false for CPU sticker exports. The same profiles work inside GPU batches.
Required range:
x >= 1Profiles support crop, reverse and fps; omit max_width.
Response
200
Queued export receipt; poll GET /v1/exports/{exportId} for validation and a download.
