图像滤镜
描述
为输入图片添加指定滤镜,并通过 filter_alpha 调整滤镜程度。调用时同时传入原图和滤镜素材包,使用 material_id 标识素材,使用 resource_url 指定素材包在输入列表中的引用名。
图片要求
- 原图格式:JPG、JPEG、PNG、BMP、HEIF。
- 原图文件大小:不超过 30 MB。
- 输入内容:1 张原图和 1 个滤镜素材包。
- 素材包使用下方列表中的 ZIP 地址,通过 URL 传入。
调用 URL
- 请求地址:`https://openapi.meitu.com/api/v1/sdk/sync/push`
- 任务名称(`task`):`/v1/Pic_Filter/477479`
- 任务类型(`task_type`):`formula`
调用方法
POST
Content-Type: application/json
权限
使用 Access Key(AK)和 Secret Key(SK)进行请求签名,详见开放平台接口签名。
请求参数
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | task | string | 固定为 /v1/Pic_Filter/477479。 |
| 必选 | task_type | string | 固定为 formula。 |
| 必选 | init_images | object[] | 输入资源列表,包含原图和滤镜素材包。使用 ref_name 标识各资源。 |
| 必选 | params | string | 算法参数序列化后的 JSON 字符串,结构见下文。 |
| 可选 | sync_timeout | int | 同步等待时间,单位为秒,默认 30;-1 表示不等待。返回 data.status = 9 时,使用任务查询接口获取结果。 |
init_images 元素
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | url | string | 原图 URL、原图 Base64 编码数据或素材包 URL,具体用途由 ref_name 指定。 |
| 必选 | profile | object | 资源传输信息及引用名。 |
profile
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 可选 | media_extra | object | 多媒体附加参数。 |
| 必选 | media_profiles | object | 资源传输方式及引用名。 |
| 可选 | version | string | 示例使用 v1。 |
media_profiles
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | media_data_type | string | url:通过 URL 传入原图或素材包;jpg:通过 Base64 编码传入原图。 |
| 必选 | ref_name | string | 原图固定为 origin。素材包可使用自定义引用名,本文示例为 resource,且必须与 parameter.resource_url 一致。 |
params
先构造以下参数对象,再将其序列化为字符串,作为请求体的 params 值。
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | parameter | object | 图像滤镜算法参数。 |
parameter
| 是否必选 | 参数名 | 类型 | 参数说明 |
|---|---|---|---|
| 必选 | material_id | string | 滤镜素材 ID,使用下方素材列表中的值,并与所传素材包对应。 |
| 必选 | resource_url | string | 素材包的引用名,必须与素材包输入项的 ref_name 一致。示例值为 resource,不是 ZIP 地址。 |
| 可选 | filter_alpha | int | 滤镜程度,取值范围为 [0, 100]。未传入时使用素材包配置的默认值。 |
| 可选 | random_idx | int | 素材包中子素材的索引,从 0 开始,上限由具体素材包配置决定。 |
| 可选 | rsp_media_type | string | 结果返回方式:url 为图片 URL,jpg 为 Base64 编码数据。默认 url。 |
| 可选 | rsp_long_side_max | int | 结果图长边的最大像素数,用于限制输出图片的宽度或高度。 |
| 可选 | rsp_jpg_quality | int | 输出 JPEG 图片的质量因子,默认 100。可根据画质与耗时需求调整,例如设置为 99。 |
resource_url、material_id、filter_alpha 等算法参数均位于 params 字符串中的 parameter 对象内。
素材包的实际下载地址填写在 init_images 对应项的 url 中。例如,该项的 ref_name 为 resource 时,parameter.resource_url 也应填写 resource。
输入值示例
以下示例使用 Cream 滤镜,素材 ID 为 ET007450,滤镜程度设为 100,结果以 URL 返回。请将 https://example.com/input.jpg 替换为实际可访问的原图地址。
{
"task": "/v1/Pic_Filter/477479",
"task_type": "formula",
"init_images": [
{
"url": "https://example.com/input.jpg",
"profile": {
"media_profiles": {
"media_data_type": "url",
"ref_name": "origin"
},
"version": "v1"
}
},
{
"url": "https://my-material.zone1.meitudata.com/b3c0fd6d58e6a03.zip",
"profile": {
"media_profiles": {
"media_data_type": "url",
"ref_name": "resource"
},
"version": "v1"
}
}
],
"params": "{\"parameter\":{\"rsp_media_type\":\"url\",\"material_id\":\"ET007450\",\"resource_url\":\"resource\",\"filter_alpha\":100}}",
"sync_timeout": 30
}切换滤镜时,同时替换 parameter.material_id 和素材包输入项的 url,两者使用素材列表同一行的值。若修改素材包的 ref_name,还需同步修改 parameter.resource_url。
返回值说明
以下说明及示例采用 URL 返回方式。任务成功后,从 data.result.urls 获取结果图片。
| 字段 | 类型 | 说明 |
|---|---|---|
| error_code | int | 错误码,0 表示请求处理正常;非 0 表示请求失败。任务是否完成需同时检查 data.status。 |
| message | string | 响应消息或错误信息。 |
| data | object/null | 任务信息;请求失败时可能为 null。 |
data
| 字段 | 类型 | 说明 |
|---|---|---|
| status | int | 任务状态:-1 未找到任务;0 已创建;1 执行中;2 失败;9 需要查询结果;10 成功。 |
| result | object | 任务 ID 和处理结果。 |
| progress | number | 任务进度,例如 0.1、0.85、1。 |
result
| 字段 | 类型 | 说明 |
|---|---|---|
| id | string | 任务 ID;查询结果时作为 task_id 参数传入。 |
| urls | string[] | 任务成功后的结果图片 URL 列表。 |
当 data.status = 9 时,使用 data.result.id 调用任务查询接口。查询请求为 GET https://openapi.meitu.com/api/v1/sdk/status?task_id=<任务ID>,同样需要签名。
查询返回状态 0 或 1 时表示任务尚未完成;10 表示成功;2 表示失败。请及时查询并保存结果,任务在 24 小时后过期,不支持历史任务查询。
返回值示例
请求成功返回示例
{
"error_code": 0,
"message": "success",
"data": {
"status": 10,
"result": {
"id": "t_mt1a3i5n7bdb4183fe-8f91-4b1c-ae95-402b6f48613b",
"urls": [
"https://example.com/result.png"
]
},
"progress": 1
}
}需要查询返回示例
使用返回的 data.result.id 作为任务查询接口的 task_id。
{
"error_code": 0,
"message": "success",
"data": {
"status": 9,
"result": {
"id": "t_mt1a3i5n7bdb4183fe-8f91-4b1c-ae95-402b6f48613b"
},
"progress": 0
}
}请求失败返回示例
{
"error_code": 20001,
"message": "PROCESS_ERROR",
"data": null
}错误代码与信息
| 错误代码 | 错误信息 | 说明 |
|---|---|---|
| 20001 | PROCESS_ERROR | 处理错误。 |
其他错误码详见 API 错误码。
SDK 调用示例
以下示例均使用 Cream 滤镜,material_id = ET007450、filter_alpha = 100。调用前替换 AK、SK 和输入图片 URL。
示例打印接口响应。返回 data.status = 9 时,按上述说明查询任务结果。选择其他滤镜时,同时修改素材 ID 和对应的素材包 URL。
Python
先按 Python 签名 SDK 接入文档引入 SDK。
import json
import requests
from sign_sdk import sign
def api_call_example():
key = "your_access_key"
secret = "your_secret_key"
url = "https://openapi.meitu.com/api/v1/sdk/sync/push"
headers = {
"Content-Type": "application/json",
sign.HeaderHost: "openapi.meitu.com",
}
inner_params = {
"parameter": {
"rsp_media_type": "url",
"material_id": "ET007450",
"resource_url": "resource",
"filter_alpha": 100
}
}
payload = {
"task": "/v1/Pic_Filter/477479",
"task_type": "formula",
"init_images": [
{
"url": "https://example.com/input.jpg",
"profile": {
"media_profiles": {
"media_data_type": "url",
"ref_name": "origin"
},
"version": "v1"
}
},
{
"url": "https://my-material.zone1.meitudata.com/b3c0fd6d58e6a03.zip",
"profile": {
"media_profiles": {
"media_data_type": "url",
"ref_name": "resource"
},
"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, "POST", headers, body)
with requests.Session() as session:
response = session.send(signed_request, timeout=60)
print("Status:", response.status_code)
print("Response:", response.text)
if __name__ == "__main__":
api_call_example()Go
先按 Go 签名 SDK 接入文档引入 SDK。
package main
import (
"fmt"
"io"
"net/http"
"time"
"github.com/mtlab/api/signer"
)
func main() {
key := "your_access_key"
secret := "your_secret_key"
signObj := signer.NewSigner(key, secret)
url := "https://openapi.meitu.com/api/v1/sdk/sync/push"
headers := make(http.Header)
headers.Set(signer.HeaderHost, "openapi.meitu.com")
headers.Set("Content-Type", "application/json")
body := `{
"task": "/v1/Pic_Filter/477479",
"task_type": "formula",
"init_images": [
{
"url": "https://example.com/input.jpg",
"profile": {
"media_profiles": {
"media_data_type": "url",
"ref_name": "origin"
},
"version": "v1"
}
},
{
"url": "https://my-material.zone1.meitudata.com/b3c0fd6d58e6a03.zip",
"profile": {
"media_profiles": {
"media_data_type": "url",
"ref_name": "resource"
},
"version": "v1"
}
}
],
"params": "{\"parameter\":{\"rsp_media_type\":\"url\",\"material_id\":\"ET007450\",\"resource_url\":\"resource\",\"filter_alpha\":100}}",
"sync_timeout": 30
}`
req, err := signObj.Sign(url, http.MethodPost, headers, body)
if err != nil {
fmt.Println("Failed to sign request:", err)
return
}
client := &http.Client{Timeout: 60 * time.Second}
resp, err := client.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("Failed to read response:", err)
return
}
fmt.Println("Status:", resp.StatusCode)
fmt.Println("Response:", string(responseBody))
}PHP
先按 PHP 签名 SDK 接入文档引入 SDK。
<?php
require_once __DIR__ . '/signer.php';
$key = 'your_access_key';
$secret = 'your_secret_key';
$url = 'https://openapi.meitu.com/api/v1/sdk/sync/push';
$headers = [
'Content-Type' => 'application/json',
'Host' => 'openapi.meitu.com',
];
$innerParams = json_encode([
'parameter' => [
'rsp_media_type' => 'url',
'material_id' => 'ET007450',
'resource_url' => 'resource',
'filter_alpha' => 100,
],
], JSON_UNESCAPED_SLASHES);
$body = json_encode([
'task' => '/v1/Pic_Filter/477479',
'task_type' => 'formula',
'init_images' => [
[
'url' => 'https://example.com/input.jpg',
'profile' => [
'media_profiles' => [
'media_data_type' => 'url',
'ref_name' => 'origin',
],
'version' => 'v1',
],
],
[
'url' => 'https://my-material.zone1.meitudata.com/b3c0fd6d58e6a03.zip',
'profile' => [
'media_profiles' => [
'media_data_type' => 'url',
'ref_name' => 'resource',
],
'version' => 'v1',
],
],
],
'params' => $innerParams,
'sync_timeout' => 30,
], JSON_UNESCAPED_SLASHES);
$signer = new Signer($key, $secret);
$curl = $signer->sign($url, 'POST', $headers, $body);
curl_setopt($curl, CURLOPT_HEADER, false);
curl_setopt($curl, CURLOPT_TIMEOUT, 60);
curl_setopt($curl, CURLOPT_SSL_VERIFYPEER, true);
curl_setopt($curl, CURLOPT_SSL_VERIFYHOST, 2);
$response = curl_exec($curl);
if ($response === false) {
echo 'Error: ' . curl_error($curl) . PHP_EOL;
} else {
echo 'Status: ' . curl_getinfo($curl, CURLINFO_HTTP_CODE) . PHP_EOL;
echo 'Response: ' . $response . PHP_EOL;
}
curl_close($curl);Java
先按 Java 签名 SDK 接入文档引入 SDK。
import com.meitu.openai.common.Signer;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.io.OutputStream;
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_access_key", "your_secret_key");
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/Pic_Filter/477479\",\n"
+ " \"task_type\": \"formula\",\n"
+ " \"init_images\": [\n"
+ " {\n"
+ " \"url\": \"https://example.com/input.jpg\",\n"
+ " \"profile\": {\n"
+ " \"media_profiles\": {\n"
+ " \"media_data_type\": \"url\",\n"
+ " \"ref_name\": \"origin\"\n"
+ " },\n"
+ " \"version\": \"v1\"\n"
+ " }\n"
+ " },\n"
+ " {\n"
+ " \"url\": \"https://my-material.zone1.meitudata.com/b3c0fd6d58e6a03.zip\",\n"
+ " \"profile\": {\n"
+ " \"media_profiles\": {\n"
+ " \"media_data_type\": \"url\",\n"
+ " \"ref_name\": \"resource\"\n"
+ " },\n"
+ " \"version\": \"v1\"\n"
+ " }\n"
+ " }\n"
+ " ],\n"
+ " \"params\": \"{\\\"parameter\\\":{\\\"rsp_media_type\\\":\\\"url\\\",\\\"material_id\\\":\\\"ET007450\\\",\\\"resource_url\\\":\\\"resource\\\",\\\"filter_alpha\\\":100}}\",\n"
+ " \"sync_timeout\": 30\n"
+ "}";
Map<String, String> signedHeaders = signer.sign(url, method, headers, body);
HttpURLConnection connection = (HttpURLConnection) new URL(url).openConnection();
try {
connection.setRequestMethod(method);
connection.setConnectTimeout(10000);
connection.setReadTimeout(60000);
connection.setInstanceFollowRedirects(false);
for (Map.Entry<String, String> entry : signedHeaders.entrySet()) {
connection.setRequestProperty(entry.getKey(), entry.getValue());
}
connection.setDoOutput(true);
try (OutputStream output = connection.getOutputStream()) {
output.write(body.getBytes(StandardCharsets.UTF_8));
}
int status = connection.getResponseCode();
System.out.println("Status: " + status);
InputStream stream = status >= 400
? connection.getErrorStream()
: connection.getInputStream();
if (stream != null) {
try (InputStream input = stream;
ByteArrayOutputStream output = new ByteArrayOutputStream()) {
byte[] buffer = new byte[4096];
int length;
while ((length = input.read(buffer)) != -1) {
output.write(buffer, 0, length);
}
System.out.println("Response: "
+ new String(output.toByteArray(), StandardCharsets.UTF_8));
}
}
} finally {
connection.disconnect();
}
}
}图像滤镜素材列表
material_id 填入 parameter.material_id;素材包 URL 填入 init_images 中素材包资源的 url。示例图仅用于预览效果,不作为素材包地址。
| 名称 | material_id | 素材包 URL |
|---|---|---|
| Cream | ET007450 | 下载素材包 |
| Classic D | ET0061997 | 下载素材包 |
| CS5 | ET0062088 | 下载素材包 |
| 霏颜 | ET0062014 | 下载素材包 |
| 撕拉片 | ET1111130 | 下载素材包 |
| 家宴 | ET1111125 | 下载素材包 |
| 小樽 | ET005043 | 下载素材包 |
| 囍宴 | ET0062161 | 下载素材包 |
| Cat | ET0061984 | 下载素材包 |
| 楼兰 | ET0061971 | 下载素材包 |
更多滤镜素材需求,请通过美图 AI 开放平台联系客服。