API

API调用说明

调用API时，参数配置如下：

• domain：nls-slp.cn-shanghai.aliyuncs.com

• version：2019-08-19

详细调用示例代码，请参见使用示例。

API详情

CosyVoiceClone：提交声音复刻任务

• 接口说明

  提交声音复刻任务，需同时设置样本音频文件和生成音频文件的前缀。

• 请求参数

  参数	类型	传参方式	是否必选	描述
  Url	String	Body	是	样本音频文件地址，须确保公网可访问。每次仅能上传1个音频，音频格式要求： 声道数：单声道 采样位数：16 bit 采样率：大于22050 Hz 格式：WAV、MP3、M4A 时长：5秒~20秒
  VoicePrefix	String	Body	是	生成音频名称的前缀，例如：tongyi。

  请求示例：

  {
      "Url": "http://****.oss-cn-hangzhou.aliyuncs.com/linjing/voicegen/dataset/Musk.wav?OSSAccessKeyId=LTAI5t8W15Y4eALUtgsu****&Expires=3601716441689&Signature=1JLsNxGoGkJE1XTpRJu7yIow4aw%3D",
      "VoicePrefix": "tongyi"
  }

• 返回参数

  参数	类型	描述
  RequestId	String	请求ID。
  Code	Integer	状态码。
  Message	String	错误信息。
  VoiceName	String	生成音频的名称，命名格式：cosyvoice-${voice_prefix}-${7位随机字符}。其中，${voice_prefix}即请求参数中设置的音频名称前缀。

  返回示例：

  {
      "RequestId": "A3136B58-5876-4168-83CA-B5627819****",
      "Code": 20000000,
      "Message": "SUCCESS",
      "VoiceName": "cosyvoice-tongyi-90fa79f"
  }

ListCosyVoice：查询指定音频名称前缀的所有声音

• 接口说明

  查询指定音频名称前缀的所有声音，可分页展示。

• 请求参数

  参数	类型	传参方式	是否必选	描述
  VoicePrefix	String	Body	是	待查询音频名称的前缀，例如：tongyi。
  PageSize	Integer	Body	否	页大小，默认值：10。
  PageIndex	Integer	Body	否	页序号，默认值：1。

  请求示例：

  {
      "VoicePrefix": "tongyi"
  }

• 返回参数

  参数	类型	描述
  RequestId	String	请求ID。
  Code	Integer	状态码。
  Message	String	错误信息。
  PageIndex	Integer	当前展示页序号。
  PageSize	Integer	当前展示页大小。
  TotalCount	Integer	当前音频名称前缀下所有声音的数量。
  Voices	List	声音列表。
  Voices[i].VoiceName	String	音频名称。
  Voices[i].Status	String	声音复刻状态。
  Voices[i].StatusDesc	String	声音复刻状态描述。
  Voices[i].GmtCreate	String	声音复刻任务创建时间，例如：2024-06-14 16:20:42。

  返回示例：

  {
      "TotalCount": 1,
      "RequestId": "C623E918-1C7E-137F-BDFE-6E872107****",
      "Message": "SUCCESS",
      "PageSize": 10,
      "PageIndex": 1,
      "Code": 20000000,
      "Voices": [
          {
              "Status": "SUCCESS",
              "StatusDesc": "复刻成功",
              "GmtCreate": "2024-06-14 16:20:42",
              "VoiceName": "cosyvoice-tongyi-0a9a15e"
          }
      ]
  }