Video Stabilization Processing

Description

Video stabilization processing.

Version

1.0

Media Requirements

Supported media file formats include wav, m4a, mp4, mp3, and aac.

API URL

    Production environment: https://openapi.meitu.com
    Task submission endpoint: https://openapi.meitu.com/api/v1/sdk/sync/push
    Task name (task): /v1/videostabilization/481968
    Task type (task_type): formula

Method

POST

Content-Type: application/json

Authentication

Open Platform API Signature

Request Parameters

RequiredParameterTypeDescription
YesparamsstringAlgorithm parameters (JSON string)
Yesinit_imagesobject[]Media file list
YestaskstringFixed value: /v1/videostabilization/481968
Yestask_typestringFixed value: formula
Nosync_timeoutintSynchronous timeout in seconds; default: 30

The init_images media file parameters are described below.

RequiredParameterTypeDescription
YesurlstringMedia URL or base64-encoded data
YesprofileobjectMedia attribute description

The profile attributes are described below.

RequiredParameterTypeDescription
Yesmedia_profilesobjectMedia attribute information
YesversionstringFixed value: v1

The media_profiles attributes are described below.

RequiredParameterTypeDescription
Yesmedia_data_typestringurl indicates a URL; types such as jpg indicate base64-encoded data

The params inference parameter is a JSON string with the following structure.

RequiredFieldTypeDescription
Norsp_media_typestringDefault: url; jpg indicates base64-encoded data
YesparameterobjectCore algorithm parameter object

The algorithm parameters in parameter are described below.

RequiredParameterTypeDescription
Yesrepost_urlstringCallback URL

Request Example

{
  "task": "/v1/videostabilization/481968",
  "task_type": "formula",
  "init_images": [
    {
      "url": "https://obs.mtlab.meitu.com/public/EtRGxLI8ulQ43pGhuZfym9aYUD2PUbMP/MTc1MzkzMDgwMA==/19a76e4c-5116-499d-6a0d-1ffc807eeb9d.mp4",
      "profile": {
        "media_profiles": {
          "media_data_type": "url"
        },
        "version": "v1"
      }
    }
  ],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"repost_url\":\"http://internal.vesdk.m.com/meitu_ai/callback\"}}",
  "sync_timeout": 30
}

Response Fields

Generated results are periodically deleted. Download and save them promptly.
FieldTypeDescription
request_idstringRequest identifier
trace_idstringTrace identifier
codeintBusiness status code; 0 indicates that the request was accepted successfully
error_codeintError code; 0 indicates success
messagestringBusiness message
tipsanyAdditional information; may be null
dataobjectTask status and algorithm result

Fields in the data object are described below.

FieldTypeDescription
statusintStatus code: -1, task not found; 0, created successfully; 1, processing; 2, failed; 9, timed out—use the Query API; 10, succeeded
resultobjectAlgorithm result
progressnumberTask progress, for example, 0.1, 0.85, or 1
predict_elapsedintEstimated processing time in milliseconds
create_timeint64Creation timestamp in milliseconds
task_idstringTask ID
custom_task_idstringClient-defined task ID
trace_idstringTrace identifier within data
client_infostringClient information
init_imagesobject[]/nullInput media echo

Fields in the result object are described below.

FieldTypeDescription
idstringTask ID
urlsstring[]Result URLs
parameterobjectReturned information type identifier
parametersobjectReturned information type identifier
dataobjectResult data
msgstringResult message
msg_idstringUnique request identifier
imagesstring[]Result URLs
media_info_listobject[]Media information list

Fields in parameters are described below.

FieldTypeDescription
rsp_media_typestringReturned media type
versionstringVideo stabilization algorithm version information

Fields in result.data are described below.

FieldTypeDescription
media_info_listobject[]Each item contains one media information object
parameterobjectReturned information type identifier
error_codeintResult error code; 0 indicates success
error_msgstringResult error message
msg_idstringUnique request identifier; used with the Query API. The identifier and algorithm result are retained for 24 hours
durationobjectDetailed timing information
extraobjectExtended information

Fields in media_info_list are described below.

FieldTypeDescription
media_datastringInput URL required for decoding by the VAE API, such as a .npy file URL
media_extranullReserved field; currently returns null
media_profilesobjectAdditional media information

Fields in media_profiles are described below.

FieldTypeDescription
media_data_fpsfloatVideo frame rate
media_data_heightintVideo height
media_data_sizeintVideo data size in bytes
media_data_typestringType of media_data; for example, url indicates a URL
media_data_widthintVideo width

Fields in duration are described below.

FieldTypeDescription
created_timestampintTimestamp when the algorithm received the request, in seconds
pull_timestampintQueue dequeue timestamp, in seconds
waiting_timeintTime spent waiting in the queue, in milliseconds
alg_process_timeintAlgorithm processing time in milliseconds, including download time
upload_timeintUpload time in milliseconds
repost_timeintAsynchronous callback API processing time in milliseconds

Fields in extra are described below.

FieldTypeDescription
trans_metaobjectTranscoding-related metadata

Fields in trans_meta are described below.

FieldTypeDescription
req_metaobject[]Requested media metadata list
rsp_metaobject[]Response media metadata list

Fields in req_meta are described below.

FieldTypeDescription
durationintMedia duration in milliseconds
media_typestringMedia type, for example, video

Fields in rsp_meta are described below.

FieldTypeDescription
data_ratefloatData rate in bit/s
durationintMedia duration in milliseconds
frame_numintTotal number of frames
frame_ratefloatFrame rate
heightintVideo height
media_typestringMedia type, for example, video
sizeintFile size in bytes
widthintVideo width

API-specific error codes and messages

ErrorCodeError MessageDescription
20001PROCESS_ERRORProcessing error

Response Examples

Successful Response Example

{
  "request_id": "request_id",
  "trace_id": "trace_id",
  "code": 0,
  "error_code": 0,
  "message": "success",
  "tips": null,
  "data": {
    "status": 10,
    "result": {
      "id": "task_id",
      "urls": [
        "https://obs-large.mtlab.meitu.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/9fe409dc-14b1-4ae0-51a2-94d030c59add/9fe409dc-14b1-4ae0-51a2-94d030c59add.mp4"
      ],
      "parameters": {
        "rsp_media_type": "url",
        "version": "videostabilzation version: 0.0.1"
      },
      "data": {
        "duration": {
          "alg_process_time": 3869,
          "created_timestamp": 1758506175,
          "pull_timestamp": 1758506458,
          "repost_time": 0,
          "upload_time": 868,
          "waiting_time": 283486
        },
        "error_code": 0,
        "error_msg": "success",
        "extra": {
          "trans_meta": {
            "req_meta": [
              {
                "duration": 11335,
                "media_type": "video"
              }
            ],
            "rsp_meta": [
              {
                "data_rate": 8559.67460685853,
                "duration": 11335,
                "frame_num": 273,
                "frame_rate": 24.08333396911621,
                "height": 1280,
                "media_type": "video",
                "size": 12745378,
                "width": 720
              }
            ]
          }
        },
        "media_info_list": [
          {
            "media_data": "https://obs-large.mtlab.meitu.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/9fe409dc-14b1-4ae0-51a2-94d030c59add/9fe409dc-14b1-4ae0-51a2-94d030c59add.mp4",
            "media_extra": null,
            "media_profiles": {
              "media_data_fps": 24.08333396911621,
              "media_data_height": 1280,
              "media_data_size": 12745378,
              "media_data_type": "url",
              "media_data_width": 720
            }
          }
        ],
        "msg_id": "msg_id",
        "parameter": {
          "rsp_media_type": "url",
          "version": "videostabilzation version: 0.0.1"
        }
      },
      "msg": "success",
      "msg_id": "msg_id",
      "images": [
        "https://obs-large.mtlab.meitu.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/9fe409dc-14b1-4ae0-51a2-94d030c59add/9fe409dc-14b1-4ae0-51a2-94d030c59add.mp4"
      ],
      "media_info_list": [
        {
          "media_data": "https://obs-large.mtlab.meitu.com/mtopen/4e200dc6bf574fee899cf9e0dabe27e6/9fe409dc-14b1-4ae0-51a2-94d030c59add/9fe409dc-14b1-4ae0-51a2-94d030c59add.mp4",
          "media_extra": null,
          "media_profiles": {
            "media_data_fps": 24.08333396911621,
            "media_data_height": 1280,
            "media_data_size": 12745378,
            "media_data_type": "url",
            "media_data_width": 720
          }
        }
      ]
    },
    "progress": 1,
    "predict_elapsed": 10000,
    "create_time": 1758506175166,
    "task_id": "task_id",
    "custom_task_id": "",
    "trace_id": "",
    "client_info": "",
    "init_images": null
  }
}

Query-Required Response Example

Use the Query API to query the result.

Response Status: 200

Content-Type: application/json; charset=utf-8

{
  "request_id": "request_id",
  "trace_id": "trace_id",
  "code": 0,
  "error_code": 0,
  "message": "success",
  "tips": null,
  "data": {
    "status": 9,
    "result": {
      "msg_id": "msg_id"
    },
    "progress": 0,
    "predict_elapsed": 10000,
    "create_time": 1758506175166,
    "task_id": "task_id",
    "custom_task_id": "",
    "trace_id": "",
    "client_info": "",
    "init_images": null
  }
}

Failed Response Example

Response Status: 400

Content-Type: application/json; charset=utf-8

{
  "request_id": "request_id",
  "trace_id": "trace_id",
  "code": 20001,
  "error_code": 20001,
  "message": "PROCESS_ERROR",
  "tips": null,
  "data": {
    "status": 2,
    "result": {
      "error_code": 20001,
      "error_msg": "PROCESS_ERROR"
    },
    "progress": 0,
    "predict_elapsed": 0,
    "create_time": 1758506175166,
    "task_id": "task_id",
    "custom_task_id": "",
    "trace_id": "",
    "client_info": "",
    "init_images": null
  }
}

General Error Codes and Messages

See API Error Codes for details.

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": {
            "repost_url": "http://internal.vesdk.m.com/meitu_ai/callback"
        },
    }
    payload = {
        "task": "/v1/videostabilization/481968",
        "task_type": "formula",
        "init_images": [
            {
                "url": "https://example.com/input.mp4",
                "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/videostabilization/481968",
  "task_type": "formula",
  "init_images": [{
    "url": "https://example.com/input.mp4",
    "profile": {
      "media_profiles": {"media_data_type": "url"},
      "version": "v1"
    }
  }],
  "params": "{\"rsp_media_type\":\"url\",\"parameter\":{\"repost_url\":\"http://internal.vesdk.m.com/meitu_ai/callback\"}}",
  "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' => [
        'repost_url' => 'http://internal.vesdk.m.com/meitu_ai/callback',
    ],
]);

$body = json_encode([
    'task' => '/v1/videostabilization/481968',
    'task_type' => 'formula',
    'init_images' => [
        [
            'url' => 'https://example.com/input.mp4',
            '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/videostabilization/481968\",\n" +
                "  \"task_type\": \"formula\",\n" +
                "  \"init_images\": [{\n" +
                "    \"url\": \"https://example.com/input.mp4\",\n" +
                "    \"profile\": {\n" +
                "      \"media_profiles\": {\"media_data_type\": \"url\"},\n" +
                "      \"version\": \"v1\"\n" +
                "    }\n" +
                "  }],\n" +
                "  \"params\": \"{\\\"rsp_media_type\\\":\\\"url\\\",\\\"parameter\\\":{\\\"repost_url\\\":\\\"http://internal.vesdk.m.com/meitu_ai/callback\\\"}}\",\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);
        }
    }
}