Skip to content

API.md

Latest commit

 

History

History
123 lines (105 loc) · 2.76 KB

API.md

File metadata and controls

123 lines (105 loc) · 2.76 KB
Raw

数字人API接口文档

欢迎使用matesx.cn来管理你的形象。matesx.cn为开发者提供服务，可以通过联系方式获取三个免费形象额度。

1. 获取账户信息

说明: 通过密钥获取用户任务信息和余额

接口地址: POST www.matesx.com/platform/api/confirm

请求头: Content-Type: application/json

请求参数:

{
    "password": "用户密钥"
}

响应成功示例:

{
    "tasks": [
        {
            "task_id": "任务ID",
            "status": "任务状态",
            "avatar_url": "数字人缩略图URL",
            "video_url": "生成的视频URL",
            "video_asset_url": "生成的数字人资源URL",
            "errorMessage": "任务出错时的信息"
            "created_time": "创建时间",
            "updated_time": "更新时间",
        }
    ],
    "avatar_balance": "形象余额",
}

python代码示例：

import requests
import json
password = ""
url = "www.matesx.com/platform/api/confirm"
headers = {
    "Content-Type": "application/json"
}
data = {
    "password": password
}
try:
    response = requests.post(url, headers=headers, json=data)
    response.raise_for_status()
    result = response.json()
    print(result)
except:
    pass

2. 上传视频文件接口

说明: 上传文件创建数字人任务，返回任务ID和状态

接口地址: POST www.matesx.com/platform/api/upload

请求格式: multipart/form-data

请求参数:

  • key: 用户密钥（必填）
  • oss_url: 视频/图片文件url（必填，支持mp4/png/jpg格式，最大30MB）
  • task_id: 任务ID（选填，若无系统会自动生成唯一ID）

响应成功示例:

{
    "code": 0,
    "message": "操作成功",
    "data": {
       "avatar_id": avatar_id,
        "new_status": "pending"
    }
}

python代码示例： 请参考https://github.com/kleinlee/MatesX/blob/main/routers/auth.py用法

3. 查询任务状态接口

接口地址: GET www.matesx.com/platform/api/task/{task_id}

请求参数:

  • task_id: 任务ID

响应成功示例:

{
    "task_id": "任务ID",
    "status": "任务状态",
    "avatar_url": "数字人缩略图URL",
    "video_url": "生成的视频URL",
    "video_asset_url": "生成的数字人资源URL",
    "errorMessage": "错误信息",
    "created_time": "创建时间",
    "updated_time": "更新时间"
}

python代码示例：

import requests

def get_task_status(task_id):
    url = f"https://www.matesx.cn/api/task/{task_id}"

    try:
        response = requests.get(url)
        response.raise_for_status()
        return response.json()
    except Exception as e:
        print(f"Query failed: {e}")
        return None

# 使用示例
task_info = get_task_status("your_task_id")
print(task_info)