1. 接口参考
MyVocal AI语音大模型API文档
  • 文字转语音大模型
    • 概览与快速开始
      • 模型介绍
      • 选择模型与接口
      • 支持语言
      • 音频格式与播放
      • 常见问题
      • SDK 与示例
    • 接口参考
      • HTTP 合成
        • HTTP 流式合成
        • HTTP 非流式合成
      • 音色管理
        • 创建声音
        • 获取声音列表
        • 删除声音
      • WebSocket 合成
        • 普通 TTS · 单连接
        • 普通 TTS · 多 Context
        • 多角色对话 · 多 Context
      • 用量与请求查询
        • 查询主key用量
        • Request_id客户端查询
        • 发音人用量查询
      • 子密钥管理
        • 创建子 Key
        • 查询子 Key 列表
        • 获取单个子 Key 详情
        • 更新子 Key
        • 查询子 Key 用量
  • 金融行业定制TTS模型
    • 文字转语音 Skyblight
      • 创建声音
      • 获取声音列表
      • 流式文字转语音
      • 非流式文字转语音
      • 删除声音
      • 用量查询
    • 全双工通信
      • websocket接入说明
      • V2 双向流式合成(WebSocket)
  • 语音转文字ASR
    • 概览与接入
      • 快速开始:文件转录
      • 快速开始:实时转录
      • 模型与能力
      • 更新记录
    • 接口参考
      • 实时转录
      • 创建文件转录
        POST
      • 查询用量
        GET
  • 企业客户声音定制服务
    • 定制属于你的专属声音
  1. 接口参考

实时转录

wss://openapi.myvocal.ai/asr/realtime
通过长连接发送音频片段,接收中间文本和最终文本。第一次接入请阅读快速开始:实时转录。

建立连接#

wss://openapi.myvocal.ai/asr/realtime?api-key=YOUR_API_KEY&model_id=echo_v1_realtime&audio_format=pcm_16000&commit_mode=manual
api-key 与 model_id 必填。通过 commit_mode 选择提交方式,完整连接参数见下方“请求参数”。
本接口使用 echo_v1_realtime。医疗模型 echo_v2_medical 不支持此接口,使用时握手返回 HTTP 400;医疗录音请使用文件转录。

发送音频消息#

连接建立并收到 session_started 后,以 JSON 文本消息发送音频。以下字段属于消息体,不属于连接 URL:
字段类型说明
message_typestring固定为 input_audio_chunk
audio_base_64stringPCM 音频数据的 Base64,不包含 WAV 文件头
sample_rateinteger与连接的音频格式一致,例如 16000
commitboolean手动模式需要提交时设为 true
previous_textstring,可选仅会话第一帧音频允许传入的上下文文本
消息结构示例(BASE64_PCM_BYTES 需替换为真实音频数据):
{
  "message_type": "input_audio_chunk",
  "audio_base_64": "BASE64_PCM_BYTES",
  "sample_rate": 16000,
  "commit": false
}
需要上下文时,将 previous_text 添加到第一帧消息。后续音频帧不要重复携带该字段;也不要把它放入 URL Query。

选择提交方式#

手动提交 · commit_mode=manual
持续发送 commit=false 的音频帧,在一个片段的最后一帧设置 commit=true,随后等待最终结果。
自动断句 · commit_mode=vad
持续发送音频,服务端根据语音活动和静音判断提交时机。需要调整断句时再配置 VAD 参数;第一次接入可使用默认设置。

接收服务端事件#

根据 message_type 分发事件。事件类型与示例如下。
事件用途
session_started会话已建立,可以发送音频
partial_transcript中间结果,文本可能继续变化
committed_transcript当前片段的最终文本
committed_transcript_with_timestamps带逐词信息的最终结果
{"message_type":"partial_transcript","text":"Hello"}
{"message_type":"committed_transcript","text":"Hello world."}
开启 word_timestamps=true 后,处理 committed_transcript_with_timestamps 中的 words。开启 include_language_detection=true 时,关注带时间戳的最终事件中返回的语言信息;同一片段可能先收到普通最终事件,再收到增强事件,不要重复保存两份文本。

错误与关闭#

握手阶段的 HTTP 400 通常表示连接参数或模型不合法;鉴权错误应检查 Key。握手成功不等于后续参数和音频已经全部通过校验。
连接建立后,处理 error、auth_error、quota_exceeded_error、input_error、invalid_request 等错误事件。例如后续音频帧重复传 previous_text 会触发输入错误。
停止采集后,先完成提交并等待最终结果,再主动关闭连接。不要将异常断连当作转录完成。

用量与接入建议#

实时转录按音频推流时长计费,计费单位为秒,价格以企业合同为准。查询用量。
音频格式使用 PCM 16-bit 单声道,采样率与 audio_format 匹配。建议以小片段持续发送,同时持续接收事件。连接 URL 中包含 Key,不要完整记录到日志。

请求参数

Query 参数

上一页
更新记录
下一页
创建文件转录
Built with