Skip to content

API 文档 (本页文档供服务端使用)

  1. 获取用户Token
url: https://api.16ai.chat/api/v1/auth/getEidToken
method: POST
headers:
 -  Authorization: `Bearer ${accessKey}`,
body:
  - eid: string // 外部 UID
  - source: string // 来源 非必填
result:
  - code: number
  - data:
    - platform: string // 平台标识
    - token: string // 用户鉴权 token
  - msg: string
  1. 根据视频id获取视频信息
url: https://api.16ai.chat/api/v1/video/info
method: POST
headers:
 -  Authorization: `Bearer ${accessKey}`,
body:
  - eid: string // 外部 UID
  - vid: number // 视频 id
result:
  - code: number
  - data:
    - id: string // 视频 id
    - status: string // ready 生成完成 | pending 生成中 | fail 失败
    - subject: string // 视频标题
    - progress: number // 生成进度
    - videoUrl: string  // 视频地址
    - thumb: string // 封面地址
     - *** other fields ***
  - msg: string
  1. 根据数字人id获取数字人信息
url: https://api.16ai.chat/api/v1/avatar/info
method: POST
headers:
 -  Authorization: `Bearer ${accessKey}`,
body:
  - eid: string // 外部 UID
  - avatarId: number // 数字人 id
result:
  - code: number
  - data:
    - id: string // 数字人 id
    - title: string // 标题
    - status: string // ready 生成完成 | pending 生成中 | fail 失败
    - progress: number // 生成进度
    - coverUrl: string // 封面地址
    - demo: string // 演示地址
     - *** other fields ***
  - msg: string
  1. 根据声音id获取声音信息
url: https://api.16ai.chat/api/v1/speaker/info
method: POST
headers:
 -  Authorization: `Bearer ${accessKey}`,
body:
  - eid: string // 外部 UID
  - speakerId: number // 声音 id
result:
  - code: number
  - data:
    - id: string // 声音 id
    - title: string // 标题
    - status: string // ready 生成完成 | pending 生成中 | fail 失败
    - progress: number // 生成进度
    - demo: string // 演示地址
     - *** other fields ***
  - msg: string
  1. 查询用户的消耗记录列表
url: https://api.16ai.chat/api/v1/record/list
method: POST
headers:
 -  Authorization: `Bearer ${accessKey}`,
body:
  - eid: string // 外部 UID
  - page: number // 第几页
  - size: number // 每页数量
result:
  - code: number
  - data:
    - list: array // 记录列表
      - status: string // 状态 done 任务完成 | locked 任务生成中 | canceled 任务视频已返回算力
      - point: number // 消耗算力
      - description: string // 算力消耗描述
      - create_time: number // 创建时间
    - page: number // 第几页
    - pages: number // 总页数
    - size: number // 每页数量
    - total: number  // 总数
  - msg: string
  1. 获取代理商余额
url: https://api.16ai.chat/api/v1/agent/getInfo
method: POST
headers:
 -  Authorization: `Bearer ${accessKey}`,
result:
  - code: number
  - data:
    - balance: number // 算力余额
    - userCount: number // 用户数量
  - msg: string
  1. 删除数字人(形象)
url: https://api.16ai.chat/creative-factory/v1/16ai/avatar/deleteByEid
method: POST
headers:
 -  Authorization: `Bearer ${accessKey}`,
body:
  - eid: string // 外部 UID
  - avatarId: number // 要删除的数字人(形象)id
result:
  - code: number // 0 表示成功
  - data: string // 成功时为 "success"
  - msg: string // 失败时的错误描述,如:删除失败,数字人模型不存在 / 删除失败,数字人模型已删除 / 删除失败,数字人模型正在处理中
  • 只能删除该 eid 对应用户名下、且类型为数字人(形象)的模型;已删除或处理中的模型不允许删除。
  1. 删除声音(音色)
url: https://api.16ai.chat/creative-factory/v1/16ai/speaker/deleteByEid
method: POST
headers:
 -  Authorization: `Bearer ${accessKey}`,
body:
  - eid: string // 外部 UID
  - speakerId: number // 要删除的声音(音色)id
result:
  - code: number // 0 表示成功
  - data: string // 成功时为 "success"
  - msg: string // 失败时的错误描述,如:删除失败,音色模型不存在 / 删除失败,音色模型已删除 / 删除失败,音色模型正在处理中
  • 只能删除该 eid 对应用户名下、且类型为声音(音色)的模型;已删除或处理中的模型不允许删除。