Fish Audio 文档
API 文档

API 文档

Fish Audio Open API 接口说明。

API 文档

Fish Audio Open API 用于服务端音频工作流,包括文字转语音、语音转文字、音色管理和口型同步。

Base URL:

https://fishaudio.org/api/open/v1

鉴权

所有请求使用 Bearer API Key:

Authorization: Bearer FISHAUDIO_API_KEY

机器可读的接口定义:

GET /api/openapi.json

当前公开能力

能力说明文档
账户信息查询账户、API 额度和积分账户与余额
文字转语音同步 HTTP、异步任务和实时接口同步异步实时
语音转文字同步 HTTP 转写语音转文字
音色管理查询、创建和删除音色音色管理
口型同步创建、查询和列出异步任务口型同步

图片、视频和实时 ASR 是否可用,以账户权限及 GET /api/openapi.json 返回的公开接口为准。

请求方式

API Key 只能保存在服务端。浏览器和移动端应先调用自己的后端,再由后端请求 Fish Audio Open API。

curl https://fishaudio.org/api/open/v1/profile \
  -H "Authorization: Bearer FISHAUDIO_API_KEY"

大多数接口使用 JSON。同步 TTS 可根据请求参数返回音频二进制或 JSON 元数据。

响应与错误

成功响应由具体接口定义。异步接口返回任务 ID,客户端应保存该 ID,并持续查询同一个任务直到终态。

错误响应格式:

{
  "code": "invalid_request",
  "message": "请求参数无效。",
  "requestId": "req_xxx"
}

请记录 requestId,便于支持人员定位请求,但不要记录 API Key、完整用户文本或私有媒体地址。

计费

不同接口会按所用模型和媒体处理方式消耗 API 额度。批量任务开始前后可查询账户与余额。异步任务必须保存任务 ID,网络中断后先恢复查询原任务,避免重复创建和重复扣费。

新接入统一使用 /api/open/v1,历史路径映射见迁移指南