latestOpenAPI 3.0.02026-08-108356.0 KB

fa6d2efc9689

Editing Endpoints

Green Screen

Try out this capability in Bria's sandbox

Description Initiates an asynchronous job that detects the video background and replaces it with a solid green (or blue) screen, producing a chroma-key-ready output for downstream compositing tools.

Response behavior:

  • Returns HTTP 202 with request_id and status_url

  • Check job status by polling status_url or by calling the Status Service with the request_id until a terminal status is returned

Supported input containers:

  • .mp4, .mov, .webm, .avi, .gif

Supported input codecs:

  • H.264, H.265 (HEVC), VP9, AV1, PhotoJPEG

Input attributes preserved in output:

  • Aspect Ratio and resolution

  • Frame Rate

  • Audio if present and preserve_audio is true

Limits:

  • Max input duration: 60 seconds

  • Resolutions: Input resolution up to 16000x16000 (16K). Inputs larger than this return 413 Payload Too Large. Output resolution matches the input resolution.

Green shade selection:

  • broadcast_green (#00B140) - industry standard for professional pipelines. Default.

  • chroma_green (#00FF00) - works with consumer editors.

  • blue_screen (#0000FF) - use when the subject wears green.

Output transparency:

  • Output is fully opaque (no alpha channel needed). mp4_h264 is recommended for broad editor compatibility.
post/green_screen

Headers

api_tokenstring required

Request body

videostring required

Publicly accessible URL of the input video. Input resolution supported up to 16000x16000 (16K)

green_shade'broadcast_green' | 'chroma_green' | 'blue_screen'

Predefined screen color. broadcast_green (#00B140) is the industry standard for professional pipelines. chroma_green (#00FF00) works with consumer editors. blue_screen (#0000FF) is used when the subject wears green.

output_container_and_codec'mp4_h264' | 'mp4_h265' | 'webm_vp9' | 'mov_h265' | 'mov_proresks' | 'mkv_h264' | 'mkv_h265' | 'mkv_vp9' | 'gif'

Output container and codec preset. Alpha is not needed for green screen output; mp4_h264 is recommended for broad editor compatibility.

preserve_audioboolean
webhook_urlstring uri

Optional URL for receiving the result via webhook when the async job completes. See Webhooks.

Response

Accepted

request_idstring required
status_urlstring required