Sign in
latestOpenAPI 3.0.02026-08-108356.0 KB

fa6d2efc9689

Masking Endpoints

Generate Mask by Key Points

Generates a segmentation mask video based on coordinate key points.

Response behavior:

  • Returns HTTP 202 with request_id and status_url
  • The final result (via Status Service) will contain a mask_url.

Constraints:

  • Max Duration: 5 seconds (Truncated if auto_trim=true).
  • Max Resolution: 750p.
post/mask_by_key_points

Headers

api_tokenstring required

Request body

videostring required

Publicly accessible URL for the input video file.

frame_indexinteger

The frame number to apply key points to.

auto_trimboolean

If true, trims the video to the 5s limit.

output_container_and_codec'mp4_h264' | 'mp4_h265' | 'webm_vp9' | 'mov_h265' | 'mov_proresks' | 'mkv_h264' | 'mkv_h265' | 'mkv_vp9' | 'gif'
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