AIMIX OpenAPI

完整调用指南

AIMIX 开放平台的接口列表、通用请求结构与任务类型指南。

概述

AIMIX 开放 API 提供视频处理服务,支持视频去重、基础合成、专业合成等功能。所有接口通过 HTTPS 调用,使用 API Key 认证。

Base URL: https://admin.aimix.pro


1. 获取 API Key

步骤

  1. 联系 AIMIX 团队申请开放应用
  2. 获取 API Key(格式:afxp_xxxxxxxxxxxx)

注意事项

  • API Key 是敏感信息,请妥善保管,不要暴露在客户端代码或公开仓库中
  • 不要将 API Key 放在 URL 参数中,必须通过请求头传递
  • 如需重置 API Key,请联系管理员

2. 认证方式

所有接口通过请求头 X-API-Key 传递 API Key:

X-API-Key: afxp_your_api_key_here

认证失败

如果 API Key 无效或已禁用,接口返回:

{
  "code": 401,
  "msg": "无效的 API Key",
  "data": null
}

3. 接口列表

方法路径说明
POST/open-api/v1/video-process/submit提交视频处理任务
GET/open-api/v1/video-process/status/{taskNo}查询任务状态
GET/open-api/v1/video-process/list分页查询任务列表
GET/open-api/v1/video-process/balance查询点数余额
GET/open-api/v1/video-process/records查询点数消耗记录

4. 提交任务接口详细参数

POST /open-api/v1/video-process/submit

通用请求结构

{
  "taskType": "任务类型",
  "callbackUrl": "回调URL(可选)",
  "clientTaskId": "客户端任务ID(可选,用于幂等校验)",
  "params": {
    // 不同任务类型参数不同,见下方详细说明
  }
}

通用响应

{
  "code": 0,
  "msg": "",
  "data": {
    "taskNo": "BT20260109001",
    "taskId": 1,
    "estimatedDotCount": 100,
    "frozenDotCount": 120,
    "totalItems": 2
  }
}

按任务类型查看

本页目录