Skip to main content
POST
Convert a video

Authorizations

Authorization
string
header
required

API key as a bearer token: Authorization: Bearer bpx_live_xxx

Body

application/json
file
string
required

The video (or animated GIF) to convert — public URL, uploaded-file URL, data URI, or raw base64.

target
enum<string>
required

Output format.

Available options:
mp4,
webm,
mov,
gif

Response

Converted. Download from url (valid several hours; file kept 7 days).

A completed format conversion. Download from url.

content_type
string
Example:

"image/webp"

credits_charged
integer

Credits charged for this conversion (2 image / 10 video / 3 audio).

filename
string

Suggested download filename.

Example:

"photo.webp"

retention
string
Example:

"7 days"

size_bytes
integer

Converted file size in bytes.

url
string<uri>

Signed download URL for the converted file (valid several hours; the file itself is kept 7 days).