Skip to content

API 概述与认证 ​

Hub 的对外接口与 AssemblyAI 官方 API 保持相同的路径和参数。官方文档里的请求,把域名换成 Hub 地址、Key 换成 Hub Key 即可。

基础地址 ​

Hub 路径前缀对应的官方服务
/v2/*https://api.assemblyai.com/v2/*(预录音转写)
/v3/token、/v3/wsstreaming.assemblyai.com(实时转写 v3)
/llm-gateway/v1/*https://llm-gateway.assemblyai.com/v1/*
/sync/v1/*https://sync.assemblyai.com/v1/*
/dictation/v1/*https://dictation.assemblyai.com/v1/*
/hub/*Hub 专属接口

账号区域为 eu 时,Hub 自动使用对应的 EU 域名(api.eu.assemblyai.com 等)。

认证 ​

以下三种方式任选其一,值为 Hub Key(hub-xxxx):

http
Authorization: hub-xxxx
Authorization: Bearer hub-xxxx
txt
?token=hub-xxxx        # 适合无法设置请求头的 WebSocket 客户端

Key 缺失或无效时返回 401:

json
{"detail": {"error": "Invalid API key"}}

指定区域 ​

http
X-Hub-Region: eu

请求只会分配给该区域的账号。未指定时使用 Key 自身设置的区域;Key 也没有设置时可使用任意账号。

参数透传 ​

除以下字段外,请求体、查询参数和请求头都原样转发给 AssemblyAI:

  • Authorization 替换为所选上游账号的 Key;
  • webhook_url 及其鉴权头由 Hub 接管后再转发给你(见 HTTPS 与回调);
  • 旧版 speech_model(单数)会被改写为 speech_models,已下线的 universal-3-pro 映射为 universal-3-5-pro。

因此 AssemblyAI 新增的参数无需升级 Hub 即可使用。可用参数以 AssemblyAI 官方文档 为准。

在线接口文档 ​

ALLOW_OPEN_DOCS=true(默认)时,/hub/docs 提供 Swagger UI,/hub/openapi.json 提供 OpenAPI 描述。

数据可见性 ​

当前版本中,Hub Key 用于鉴权和用量统计,不做数据隔离:任意有效 Key 都可以列出、查询和删除经 Hub 创建的全部转写。请只把 Key 发给可信的应用;需要隔离不同团队的数据时,请分别部署实例。

文档版本 v3.4.0 · 与项目版本同步