Add Watermark Sticker to Video
Description
This API adds a watermark sticker to a video in the cloud.
Version
1.0
Media Requirements
Video requirements:
- Format: MP4
- Size: Less than 3 GB
Sticker requirements:
- Formats: JPG, PNG, GIF
- Size: Less than 10 MB
API URL
Production environment: https://openapi.meitu.com
Task submission endpoint: https://openapi.meitu.com/api/v1/sdk/sync/push
Task name (task): /v1/Video_watermark_sticker/487154
Task type (task_type): formulaMethod
POST
Content-Type: application/json
Authentication
Request Parameters
| Required | Parameter | Type | Description |
|---|---|---|---|
| Yes | params | string | Algorithm parameters (JSON string) |
| Yes | init_images | object[] | Media file list; the first item is the video, and the second item is the watermark sticker |
| Yes | task | string | Fixed value: /v1/Video_watermark_sticker/487154 |
| Yes | task_type | string | Fixed value: formula |
| No | sync_timeout | int | Defaults to 30; synchronous timeout duration |
The structure of each media file in init_images is as follows:
| Required | Parameter | Type | Description |
|---|---|---|---|
| Yes | url | string | URL or base64 data of the video or watermark sticker |
| Yes | profile | object | Media attribute information |
The structure of profile is as follows:
| Required | Parameter | Type | Description |
|---|---|---|---|
| Yes | media_profiles | object | Media properties |
| Yes | version | string | Fixed value: v1 |
The structure of media_profiles is as follows:
| Required | Parameter | Type | Description |
|---|---|---|---|
| Yes | media_data_type | string | url indicates a URL; the corresponding media type indicates base64 data |
The params inference parameter is a JSON string with the following structure:
| Required | Field | Type | Description |
|---|---|---|---|
| No | rsp_media_type | string | Defaults to url; jpg indicates base64 data |
| Yes | parameter | object | Core algorithm parameters |
Details of the parameter object:
| Required | Parameter | Type | Description |
|---|---|---|---|
| Yes | watermark | object | Watermark sticker parameters |
Details of the watermark object:
| Required | Parameter | Type | Description |
|---|---|---|---|
| Yes | gravity | string | Watermark type; sticker indicates a sticker watermark |
| No | opacity | float | Watermark opacity, ranging from 0 to 1 |
| No | offsetx | int | Watermark offset along the X-axis, in pixels |
| No | offsety | int | Watermark offset along the Y-axis, in pixels |
| No | sticker_cropped | boolean | Whether to crop the watermark sticker; defaults to false |
Request Example
{
"task": "/v1/Video_watermark_sticker/487154",
"task_type": "formula",
"init_images": [
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/demo.mp4",
"profile": {
"media_profiles": {
"media_data_type": "url"
},
"version": "v1"
}
},
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/logo.gif",
"profile": {
"media_profiles": {
"media_data_type": "url"
},
"version": "v1"
}
}
],
"params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"watermark\":{\"gravity\":\"sticker\",\"opacity\":1,\"offsetx\":50,\"offsety\":10,\"sticker_cropped\":false}}}",
"sync_timeout": 30
}Response Fields
Generated results are periodically deleted. Download and save them promptly.| Field | Type | Description |
|---|---|---|
| request_id | string | Request identifier |
| trace_id | string | Trace identifier |
| code | int | Business status code; 0 indicates that the request was accepted successfully |
| error_code | int | Error code; 0 indicates success |
| message | string | Business message |
| tips | any | Additional information; may be null |
| data | object | Task status and algorithm result |
Fields in data:
| Field | Type | Description |
|---|---|---|
| status | int | Status code: -1, task not found; 0, created; 1, processing; 2, failed; 9, timed out—use the query API; 10, succeeded |
| result | object | Algorithm result |
| progress | number | Task progress, ranging from 0 to 1 |
| predict_elapsed | int | Estimated processing time, in milliseconds |
| create_time | int64 | Task creation timestamp, in milliseconds |
| task_id | string | Task ID |
| custom_task_id | string | Client-defined task ID |
| trace_id | string | Trace identifier within data |
| client_info | string | Client information |
| init_images | object[]/null | Echoed input media |
Fields in result:
| Field | Type | Description |
|---|---|---|
| id | string | Unique task identifier |
| urls | array | List of output media URLs |
| images | array | List of output media; equivalent to urls |
| parameters | object | Output parameter information |
| data | object | Detailed algorithm response data |
| msg | string | Response message |
| msg_id | string | Message ID |
| mtlab_res | object | Underlying algorithm response |
| media_info_list | array | List of output media information |
Fields in result.parameters:
| Field | Type | Description |
|---|---|---|
| rsp_media_type | string | Response media type; url indicates a URL |
Fields in result.data:
| Field | Type | Description |
|---|---|---|
| duration | object | Processing time statistics for each stage |
| error_code | int | Algorithm error code; 0 indicates success |
| error_msg | string | Algorithm error message |
| extra | object | Additional fields |
| media_info_list | array | List of media information |
| msg_id | string | Message ID |
| parameter | object | Echoed parameters |
Fields in duration:
| Field | Type | Description |
|---|---|---|
| alg_process_time | number | Algorithm processing time, in milliseconds |
| created_timestamp | number | Task creation timestamp, in seconds |
| pull_timestamp | number | Resource retrieval timestamp, in seconds |
| repost_time | number | Retry time |
| upload_time | number | Upload time, in milliseconds |
| waiting_time | number | Queue waiting time, in milliseconds |
Fields in media_info_list:
| Field | Type | Description |
|---|---|---|
| media_data | string | Media data URL |
| media_extra | object | Additional media information |
| media_profiles | object | Media properties |
Fields in media_profiles:
| Field | Type | Description |
|---|---|---|
| media_data_type | string | Media data type; url indicates that the media data is a URL |
Fields in mtlab_res:
| Field | Type | Description |
|---|---|---|
| ErrorCode | int | Underlying error code |
| ErrorMsg | string | Underlying error message |
| error_code | int | Error code (compatibility field) |
| error_msg | string | Error message (compatibility field) |
| media_info_list | array | List of media information |
| msg_id | string | Message ID |
| parameter | object | Parameter information |
API-specific error codes and messages:
| ErrorCode | Error Message | Description |
|---|---|---|
| 20001 | PROCESS_ERROR | Processing error |
| 21105 | INVALID_NUMBER_OF_PARAMETERS | Incorrect number of parameters |
| 21202 | INPUT_FILE_DOWNLOAD_FAILED | Failed to download the input file |
| 21205 | VIDEO_FILE_NOT_FOUND | Video file not found |
| 21206 | WATERMARK_FILE_NOT_FOUND | Watermark file not found |
| 21207 | INVALID_OR_UNSUPPORTED_INPUT_VIDEO | Invalid or unsupported input video |
| 21208 | INVALID_OR_UNSUPPORTED_WATERMARK_IMAGE | Invalid or unsupported watermark image |
| 22202 | INVALID_OUTPUT_VIDEO_LINK | Invalid output video link |
| 25201 | INPUT_FILE_EXCEEDS_MAX_SIZE | Input file exceeds the maximum size |
| 29001 | VIDEO_PROCESSING_ERROR | Video processing error |
| 29002 | INVALID_WATERMARK_OPACITY | Invalid watermark opacity |
| 29003 | INVALID_WATERMARK_SCALE_FACTOR | Invalid watermark scale factor |
| 29004 | INVALID_WATERMARK_POSITION | Invalid watermark position |
| 29005 | INVALID_OR_UNSUPPORTED_VIDEO_CODEC | Invalid or unsupported video codec |
| 29006 | INVALID_VIDEO_CODEC_PRESET | Invalid video codec preset |
| 29007 | INVALID_STICKER_CROPPING | Invalid sticker cropping option |
| 29008 | INVALID_STICKER_HORIZONTAL_OFFSET | Invalid horizontal sticker offset |
| 29009 | INVALID_STICKER_VERTICAL_OFFSET | Invalid vertical sticker offset |
Response Examples
Successful Response Example
{
"request_id": "",
"trace_id": "",
"code": 0,
"error_code": 0,
"message": "success",
"tips": null,
"data": {
"status": 10,
"result": {
"id": "t_mt1a3i5n7be056d8cb-xxxx-4db4-b057-4ac1e397bf97",
"urls": [
"https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d19663bc-2f09-4d08-4c12-76ba9d9dd7b6.mp4"
],
"parameters": {
"rsp_media_type": "url"
},
"data": {
"duration": {
"alg_process_time": 112500,
"created_timestamp": 1770276512,
"pull_timestamp": 1770276512,
"repost_time": 0,
"upload_time": 207,
"waiting_time": 57
},
"error_code": 0,
"error_msg": "success",
"extra": {},
"media_info_list": [
{
"media_data": "https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d19663bc-2f09-4d08-4c12-76ba9d9dd7b6.mp4",
"media_extra": null,
"media_profiles": {
"media_data_type": "url"
}
}
],
"msg_id": "88633f1f-xxxx-4a19-6a91-r0099cf15af6",
"parameter": {
"rsp_media_type": "url"
}
},
"msg": "success",
"msg_id": "88633f1f-xxxx-4a19-6a91-r0099cf15af6",
"images": [
"https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d19663bc-2f09-4d08-4c12-76ba9d9dd7b6.mp4"
],
"mtlab_res": {
"ErrorCode": 0,
"ErrorMsg": "",
"error_code": 0,
"error_msg": "",
"media_info_list": null,
"msg_id": "88633f1f-xxxx-4a19-6a91-r0099cf15af6",
"parameter": null
},
"media_info_list": [
{
"media_data": "https://obs-large.mtlab.meitu.com/mtopen/ff56d688358849259556be0f50065a60/d19663bc-2f09-4d08-4c12-76ba9d9dd7b6.mp4",
"media_extra": null,
"media_profiles": {
"media_data_type": "url"
}
}
]
},
"progress": 1,
"predict_elapsed": 10000,
"create_time": 1770276512525,
"task_id": "t_mt1a3i5n7be056d8cb-xxxx-4db4-b057-4ac1e397bf97",
"custom_task_id": "",
"trace_id": "",
"client_info": "",
"init_images": null
}
}Query Required Response Example
Use the query API to retrieve the result.
Response Status: 200
content-type: application/json; charset=utf-8
{
"request_id": "",
"trace_id": "",
"code": 0,
"error_code": 0,
"message": "success",
"tips": null,
"data": {
"status": 9,
"result": {
"id": "t_mt1a3i5n7be056d8cb-xxxx-4db4-b057-4ac1e397bf97"
},
"progress": 0,
"predict_elapsed": 10000,
"create_time": 1770276512525,
"task_id": "t_mt1a3i5n7be056d8cb-xxxx-4db4-b057-4ac1e397bf97",
"custom_task_id": "",
"trace_id": "ec2460cf-xxxx-48ed-9a97-32596617c779",
"client_info": "",
"init_images": null
}
}Failed Response Example
Response Status: 400
content-type: application/json; charset=utf-8
{
"request_id": "",
"trace_id": "",
"code": 0,
"error_code": 0,
"message": "success",
"tips": null,
"data": {
"status": 2,
"result": {
"error_code": 20001,
"error_msg": "PROCESS_ERROR"
},
"progress": 0,
"predict_elapsed": 0,
"create_time": 1770276512525,
"task_id": "t_mt1a3i5n7be056d8cb-xxxx-4db4-b057-4ac1e397bf97",
"custom_task_id": "",
"trace_id": "ec2460cf-xxxx-48ed-9a97-32596617c779",
"client_info": "",
"init_images": null
}
}General Error Codes
See API Error Codes.
SDK Examples
Python
import json
import requests
from sign_sdk import sign
def api_call_example():
key = "your_api_key"
secret = "your_api_secret"
url = "https://openapi.meitu.com/api/v1/sdk/sync/push"
method = "POST"
headers = {
"Content-Type": "application/json",
sign.HeaderHost: "openapi.meitu.com",
}
inner_params = {
"rsp_media_type": "url",
"parameter": {
"watermark": {
"gravity": "sticker",
"opacity": 1,
"offsetx": 50,
"offsety": 10,
"sticker_cropped": False,
}
},
}
payload = {
"task": "/v1/Video_watermark_sticker/487154",
"task_type": "formula",
"init_images": [
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/demo.mp4",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1",
},
},
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/logo.gif",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1",
},
},
],
"params": json.dumps(inner_params, ensure_ascii=False),
"sync_timeout": 30,
}
body = json.dumps(payload, ensure_ascii=False)
signer = sign.Signer(key, secret)
signed_request = signer.sign(url, method, headers, body)
response = requests.Session().send(signed_request)
print(f"Status: {response.status_code}")
print(f"Response: {response.text}")
if __name__ == "__main__":
api_call_example()Go
package main
import (
"fmt"
"io"
"net/http"
"github.com/mtlab/api/signer"
)
func main() {
key := "your_api_key"
secret := "your_api_secret"
signObj := signer.NewSigner(key, secret)
url := "https://openapi.meitu.com/api/v1/sdk/sync/push"
method := http.MethodPost
headers := make(http.Header)
headers.Set(signer.HeaderHost, "openapi.meitu.com")
headers.Set("Content-Type", "application/json")
body := `{
"task": "/v1/Video_watermark_sticker/487154",
"task_type": "formula",
"init_images": [
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/demo.mp4",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1"
}
},
{
"url": "https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/logo.gif",
"profile": {
"media_profiles": {"media_data_type": "url"},
"version": "v1"
}
}
],
"params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"watermark\":{\"gravity\":\"sticker\",\"opacity\":1,\"offsetx\":50,\"offsety\":10,\"sticker_cropped\":false}}}",
"sync_timeout": 30
}`
req, err := signObj.Sign(url, method, headers, body)
if err != nil {
fmt.Println("Failed to sign request:", err)
return
}
resp, err := http.DefaultClient.Do(req)
if err != nil {
fmt.Println("Failed to send request:", err)
return
}
defer resp.Body.Close()
responseBody, err := io.ReadAll(resp.Body)
if err != nil {
fmt.Println("Read response failed:", err)
return
}
fmt.Println("Response:", resp.StatusCode, string(responseBody))
}PHP
<?php
require 'signer.php';
$key = 'your_api_key';
$secret = 'your_api_secret';
$signer = new Signer($key, $secret);
$url = 'https://openapi.meitu.com/api/v1/sdk/sync/push';
$method = 'POST';
$headers = ['Content-Type' => 'application/json'];
$innerParams = json_encode([
'rsp_media_type' => 'url',
'parameter' => [
'watermark' => [
'gravity' => 'sticker',
'opacity' => 1,
'offsetx' => 50,
'offsety' => 10,
'sticker_cropped' => false,
],
],
]);
$body = json_encode([
'task' => '/v1/Video_watermark_sticker/487154',
'task_type' => 'formula',
'init_images' => [
[
'url' => 'https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/demo.mp4',
'profile' => [
'media_profiles' => ['media_data_type' => 'url'],
'version' => 'v1',
],
],
[
'url' => 'https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/logo.gif',
'profile' => [
'media_profiles' => ['media_data_type' => 'url'],
'version' => 'v1',
],
],
],
'params' => $innerParams,
'sync_timeout' => 30,
]);
$curl = $signer->sign($url, $method, $headers, $body);
$response = curl_exec($curl);
$status = curl_getinfo($curl, CURLINFO_HTTP_CODE);
if ($status === 0) {
echo 'Error: ' . curl_error($curl);
} else {
echo "Status: {$status}\n";
echo "Response: {$response}\n";
}
curl_close($curl);
?>Java
package com.meitu.openai.common;
import java.io.BufferedReader;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.net.HttpURLConnection;
import java.net.URL;
import java.nio.charset.StandardCharsets;
import java.util.HashMap;
import java.util.Map;
public class Main {
public static void main(String[] args) throws Exception {
Signer signer = new Signer("your_api_key", "your_api_secret");
String url = "https://openapi.meitu.com/api/v1/sdk/sync/push";
String method = "POST";
Map<String, String> headers = new HashMap<>();
headers.put("Content-Type", "application/json");
headers.put(Signer.HeaderHost, "openapi.meitu.com");
String body = "{\n" +
" \"task\": \"/v1/Video_watermark_sticker/487154\",\n" +
" \"task_type\": \"formula\",\n" +
" \"init_images\": [\n" +
" {\n" +
" \"url\": \"https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/demo.mp4\",\n" +
" \"profile\": {\n" +
" \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
" \"version\": \"v1\"\n" +
" }\n" +
" },\n" +
" {\n" +
" \"url\": \"https://meitu-commons-test.obs.cn-north-4.myhuaweicloud.com/faas/demo/logo.gif\",\n" +
" \"profile\": {\n" +
" \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
" \"version\": \"v1\"\n" +
" }\n" +
" }\n" +
" ],\n" +
" \"params\": \"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"watermark\\\":{\\\"gravity\\\":\\\"sticker\\\",\\\"opacity\\\":1,\\\"offsetx\\\":50,\\\"offsety\\\":10,\\\"sticker_cropped\\\":false}}}\",\n" +
" \"sync_timeout\": 30\n" +
"}";
Map<String, String> signedHeaders = signer.sign(url, method, headers, body);
HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
connection.setRequestMethod(method);
for (Map.Entry<String, String> entry : signedHeaders.entrySet()) {
connection.setRequestProperty(entry.getKey(), entry.getValue());
}
connection.setDoOutput(true);
connection.getOutputStream().write(body.getBytes(StandardCharsets.UTF_8));
int status = connection.getResponseCode();
InputStream stream = status >= 400
? connection.getErrorStream()
: connection.getInputStream();
try (BufferedReader reader = new BufferedReader(new InputStreamReader(stream))) {
StringBuilder response = new StringBuilder();
String line;
while ((line = reader.readLine()) != null) {
response.append(line);
}
System.out.println("Response: " + status + " " + response);
}
}
}