Masking

Foreground Mask

Changed on

Initiates an asynchronous foreground mask generation job for a video.

Response behavior:

  • Returns HTTP 202 with request_id and status_url
  • Check job status by polling status_url or by calling the status endpoint 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

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.
post/foreground_mask

Request

  • Base URL: https://engine.prod.bria-api.com/v2/video/generate
  • URL: https://engine.prod.bria-api.com/v2/video/generate/foreground_mask
  • Auth: API key in header api_token

Request body

videostring required

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

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

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

Changes

  • f9df9314620fRevision changes
    • warning

      deleted the header request parameter api_token

    • info

      api tag Masking added

    • info

      api tag Masking Endpoints removed