石榴AI开放平台
    石榴AI开放平台
    • Overview
      • Authentication
      • Limits
    • API
      • Speaker
        • Create Speaker
        • Text To Speech
        • List Speakers
        • Query Status
        • Recreate Speaker
        • Delete Speaker
        • Get Recreated Record
      • Avatar
        • Train Avatar Model
        • Train Avatar Model By Image
        • Query Training Status
        • List Avatars
        • Delete Avatar
      • Video
        • Query Status
        • Create Video By Voice
        • Create Video By AudioFile
        • Create Video By Text
      • Asset
        • Get Asset
        • Get Records
      • Upload
        • Get Upload URL
      • AuthVideo
        • Create ​Authorization Video​
    • Error Code
      • Error Code

    API文档 - 概览

    简介#

    💡
    本文档提供了第三方系统接入石榴AI的API服务信息。
    API v1版本共包括六大部分:
    1
    Speaker 语音
    Create Speaker 创建音色模型
    Recreate Speaker 重新创建音色模型
    Text To Speech 文字合成语音
    Query Status 查询音色状态
    List Speakers 查询可用音色列表
    Get Recreated Record 查询音色重新训练记录
    Delete Speaker 删除音色模型
    2
    Avatar 数字人
    Train Avatar Model 训练数字人模型
    Train Avatar Model By Image 训练照片数字人模型
    Query Training Status 查询训练生成状态
    List Avatars 查询可用数字人的列表
    Delete Avatar 删除数字人模型
    3
    Video 视频
    Query Video Status 查询视频生成的状态
    Create Video By Voice 通过音频URL驱动生成视频
    Create Video By AudioFile 通过音频文件驱动生成视频
    Create Video By Text 通过文本驱动生成视频
    4
    Asset 资产
    Get Asset 查询账户剩余权益
    Get Records 查询账户算力变更记录
    5
    Upload 上传
    Get Upload URL 生成预签名URL,用于使用PUT请求方法上传文件至腾讯云的对象存储
    6
    AuthVideo 授权视频
    Create Authorization Video 创建授权视频任务,用于训练数字人模型的前置校验

    使用流程#

    📌
    想要使用完整的服务,需要拥有训练好的音色与数字人模型(音色模型以speakerId作为唯一标识,数字人模型以avatarId作为唯一标识),可按照以下步骤对API进行使用,其中部分接口参数需要的音视频的URL如果不方便提供,可以使用Upload目录下的【Get Upload URL】接口获取预签名地址,再将文件上传至腾讯云对象存储,即可使用object参数替代URL。
    1
    音色模型
    在API的 Voice 目录下,首先调用【Create Speaker】接口进行音色模型的创建,该接口会返回一个音色ID(speakerID),然后可通过【Query Status】或【List Speakers】接口查询训练结果与获取音色ID。
    如果对音色克隆的结果不满意,可利用【Recreate Speaker】接口进行重新训练,可重新训练4次。
    当拥有了训练成功的音色ID后,我们可以调用【Text To Speech】接口使用语音合成的服务或用于训练数字人模型。
    2
    数字人模型
    提供合适的视频素材后,我们可以进行数字人模型的训练,在API的 Avatar 目录下,调用【Train Avatar Model】接口创建训练任务,该接口会返回一个数字人ID(avatarID)。
    可通过【Query Training Status】接口查询任务的实时训练状态。
    后续可使用【List Avatars】接口来查询可用数字人模型列表。
    3
    视频合成
    在API的 Video 目录下,选择【Create Video By Voice】、【Create Video By AudioFile】、【Create Video By Text】接口能够完成语音或文本驱动的数字人视频生成,最终的视频结果可通过【Query Status】查询,视频文件将以URL的形式返回,由于URL具有时效性,请尽快转存。

    认证方式#

    💡
    所有接口均采用 Bearer Token 认证方式,需要在请求的 Header 中填入 "Authorization":"Bearer ${token}"。
    在调用前请先联系管理员获取 token,管理员联系方式通过下方二维码添加或邮箱联系。
    管理员企业微信

    基础URL#

    📌
    所有API请求的BaseURL为:https://api.16ai.chat/api/v1/

    请求和响应格式#

    📌
    请求和响应的数据格式均为JSON。
    其中响应结构为
    {
        "code": 0,
        "data": any,
        "msg": ""
    }
    如果接口返回正常,code值为0,data为any类型的数据,msg的内容为空
    如果接口失败或异常,code值为非零,data为空,msg的值为错误原因
    修改于 2025-05-15 09:58:41
    下一页
    Authentication
    Built with