Skip to main content
POST

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
resolution
enum<string>

Resolution

Available options:
1280x720,
1920x1080,
2560x1440,
3840x2160,
7680x4320,
custom
customWidth
number

Width (px)

Required range: 1 <= x <= 15360
customHeight
number

Height (px)

Required range: 1 <= x <= 8640
frameRate
enum<string>

Frame rate (FPS)

Available options:
24,
30,
60,
120
codec
enum<string>

Codec

Available options:
h264,
h265,
vp9,
av1
quality
enum<string>

Quality

Available options:
low,
medium,
high,
veryhigh
audioBitrate
enum<string>

Audio bitrate

Available options:
0,
64,
128,
192,
320

Response

Tool output

outputs
object
required
tool
string
required

The tool's slug, echoing the {slug} in the request path.

tool_version
string
required

Output-contract version for this tool.

credits_used
integer
required

Credits this call consumed, after any settlement refund. 0 when metering is disabled.

credits_remaining
integer | null
required

Credits left in the current monthly allowance, or null when metering is disabled.

request_id
string

Correlation id, also sent as x-request-id.