About this endpoint
What it does
Applies a watermark to an uploaded video and returns the processed video as a streamed binary download. The request sends the source video plus either a text watermark or an image watermark, along with optional sizing and placement settings.
Request Body
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| video | String | Yes | Source video file. Supported formats: .mp4, .mkv, .avi, .mov, .flv, .3gp, .webm. Max size: 500 MiB. |
| box | Integer | No | Controls the watermark box setting. Allowed values: 0, 1. Default: 0. |
| size | String | No | Output video scale in WxH format. Dimensions must be even. Example: 1280x720. |
| gif_loop | ENUM | No | Allowed values: true, false, 0, 1. |
| watermark_text | String | No | Text watermark. Required unless watermark_image is provided. Example: ApyHub. |
| watermark_image | String | No | Image watermark file. Supported formats: .jpg, .jpeg, .png, .gif. Required unless watermark_text is provided. |
| watermark_opacity | Number | No | Watermark opacity. Range: 0 to 1. Default: 0.5. |
| watermark_position | ENUM | No | Watermark placement. Allowed values: top_right, top_left, bottom_right, bottom_left, center, bottom_center, top_center, center_left, center_right. Default: bottom_right. |
| watermark_font_size | Integer | No | Font size for text watermark. Minimum: 1. Default: 24. |
| watermark_font_color | String | No | Text watermark font color. Example format: hex color such as #ffffff. |
| watermark_image_size | String | No | Size for the image watermark. Example format: 120x40. |
| watermark_text_padding | String | No | Padding for the text watermark. Default: 10. |
| watermark_text_background_color | String | No | Background color behind the text watermark. Example format: hex color such as #000000. |
Response
Returns a binary file stream as a JSON string with format: binary, representing the processed video download.
| Parameter | Type | Mandatory | Description |
|---|---|---|---|
| value | String | Yes | Binary video content returned by the endpoint. |
Notes
You must provide exactly one watermark source: either watermark_text or watermark_image. The schema marks both as optional individually, but each is required unless the other is supplied.