API Reference

Speech to text with subtitles API

REQUEST audio-to-text-api ID 42

Transcribe audio or video into text and timed subtitles.

REQUEST https://xiaoapis.com/api/audio/audiototext

Get an API key Console / try it Open Markdown

Overview

ASR 转写
字幕/时间轴
异步任务

Use cases

口播转写
字幕生成
智能剪辑预处理

Conventions

Gateway · https://xiaoapis.com
Auth · send key (query or JSON body, as this API specifies)
Response · JSON. Check the business code and the HTTP status, not only HTTP 200

Authentication

Send the platform API key (query parameter key or JSON field key, as this page specifies). Create one in API key management.

REQUEST https://xiaoapis.com/api/audio/audiototext
Content-Type: application/json

{
  "key": "YOUR_API_KEY"
}

Request example

/api/audio/audiototext?key=你的key&url=https://example.com/demo.mp3

Details

请求HEADER：

名称	值
Content-Type	application/x-www-form-urlencoded;charset:utf-8; 或 application/json

请求参数说明：

名称	必填	类型	示例值	说明
key	是	string	35kj5jnlj53453kl5j43nj5	接口密钥,在控制台->密钥管理查看
url	否	string	https://example.com/demo.mp3	视频或音频公网 URL，提交任务时必填（兼容 audio_url）。支持 mp3、mp4、wav、m4a、aac、flac、ogg 等，最大 2GB / 12 小时
taskId	否	string	640c4f3f-6545-4102-88f6-703a826bdd14	查询任务 ID，查询时必填（兼容 task_id）；提交任务时不用传
language	否	string	zh	识别语言，留空自动识别。支持：zh 中文、en 英文、ja 日语、yue 粤语、ko 韩语、de 德语、fr 法语、ru 俄语

提交传 url，查询传 taskId。计费按音频时长，不足 1 分钟按 1 分钟；单价 5 点/分钟（约 0.05 元/分钟）。查询不扣费。提交成功即扣费；若未能探测时长，先按 1 分钟预扣，查询成功后若实际更长再补扣差额。

返回参数说明：

名称	类型	说明
code	int	状态码，200 表示成功
msg	string	状态信息
data	object	请求结果数据集
data.taskId	string	任务ID
data.url	string	音频/视频地址
data.format	string	格式
data.seconds	string	时长（秒）
data.sampling_rate	string	采样率
data.task_status	string	PENDING 已提交、RUNNING 处理中、SUCCEEDED 成功、FAILED 失败、UNKNOWN 过期或不存在
data.submission_time	string	提交时间
data.completion_time	string	完成时间
data.text	string	识别文本
data.subtitle	string	组装好的 SRT 字幕，可直接保存为 .srt
data.srt	string	同 subtitle，便于直接使用
data.sentences	array	含 speaker 说话人、句级时间戳、words 词级时间戳
data.bill_minutes	int	计费分钟数（提交时返回）
data.power_cost	number	本次扣除点数（提交时返回）
debug	string/array	调试数据
exec_time	float	执行耗时
ip	string	客户端IP

Response example

{"code": 200, "msg": "查询成功", "data": {"taskId": "640c4f3f-6545-4102-88f6-703a826bdd14", "task_id": "640c4f3f-6545-4102-88f6-703a826bdd14", "url": "https://example.com/demo.mp3", "format": "mp3", "seconds": "12.8", "sampling_rate": "16000", "task_status": "SUCCEEDED", "text": "大家好，欢迎使用语音转文本字幕接口。", "subtitle": "1\n00:00:00,500 --> 00:00:04,200\n大家好，欢迎使用语音转文本字幕接口。\n", "srt": "1\n00:00:00,500 --> 00:00:04,200\n大家好，欢迎使用语音转文本字幕接口。\n", "sentences": [{"speaker": "1", "sentence": "大家好，欢迎使用语音转文本字幕接口。", "start_time": 500, "end_time": 4200, "words": [{"word": "大", "start_time": 500, "end_time": 700}, {"word": "家", "start_time": 700, "end_time": 900}]}]}, "exec_time": 0.32, "ip": "1.2.3.4"}

Error codes

错误码	类型	说明
403	int	没有权限 / 密钥无效
400	int	参数传递不正确或点数不足
500	int	服务器内部错误

FAQ

语音转文本 API 怎么用？

提交公网音视频 URL 创建任务，查询完成后获取 text / srt / sentences 等字段。

支持哪些格式？

常见音视频格式以文档为准，注意大小与时长上限。

能直接给智能剪辑用吗？

可以。转写得到的字幕结构常用于真人口播等接口的 subtitle 字段。

是同步还是异步？

一般为异步：先拿 task_id，再查询任务状态。

返回字幕格式？

通常提供文本与 SRT/分句时间戳，详见返回示例。

识别不准确怎么办？

尽量使用清晰人声、减少噪声；必要时人工校对后再写入剪辑参数。

Full console doc (with the debugger):/doc/42