Render

Render a clip

A background, captions that appear on a schedule, an optional watermark and an optional audio bed, encoded to MP4.

Rendered inside the request, so clips are capped at 60 seconds. A clip counts its output seconds, rounded up: render.video_second_fhd for the 1080p sizes (vertical, landscape) and render.video_second_hd for 720p and square. Its duration is reserved before the encode and committed when the clip is delivered; a clip that fails to render counts nothing.

Every asset URL is fetched by us through the same guard a screenshot target faces, and each is capped at 64 MB.

post/v1/video

Request

  • Base URL: https://api.ironfang.com/render
  • URL: https://api.ironfang.com/render/v1/video
  • Auth: HTTP bearer

Headers

Idempotency-Keystring

Makes a synchronous render happen, and count, at most once. Any string up to 255 characters, remembered per account. The first request under a key is admitted and rendered as usual; a synchronous result is not kept, so the same request again under the key is a 409 idempotency_key_used and reserves nothing - send a new key to render again. A different request under a used key is a 409 idempotency_conflict. An identical request inside the cache window is still served from cache.

Request body

audiostring uri

An audio track, trimmed to the clip's length.

backgroundstring uri

An image or video to fill the canvas, cropped to fit.

colourstring

Background colour, used when no background asset is given.

durationnumber

Seconds of output.

font_sizeinteger

Caption size in pixels; defaults to a fifteenth of the width.

size'vertical' | 'square' | 'landscape' | '720p'

vertical 1080x1920, square 1080x1080, landscape 1920x1080, 720p 1280x720.

watermarkstring uri

A PNG placed in the bottom right corner.

Response

The rendered clip.

Changes

No recorded changes to this operation across all 1 revision of this API.