ListenHubOpenAPI

认证与安全

Base URL、API Key 使用方式和请求限制。

Base URL

所有 API 请求发送到:

https://api.marswave.ai/openapi

如需接入测试环境,请联系 support@marswave.ai

API Key

获取 API Key

  1. 访问 API Key 设置页面
  2. 点击「创建 API Key」
  3. 复制并保存

使用方式

在每个请求的 Authorization 头中携带 API Key:

curl -X GET "https://api.marswave.ai/openapi/v1/speakers/list" \
  -H "Authorization: Bearer $LISTENHUB_API_KEY"
const response = await fetch('https://api.marswave.ai/openapi/v1/speakers/list', {
  headers: {
    'Authorization': `Bearer ${process.env.LISTENHUB_API_KEY}`,
  },
});
import os
import requests

response = requests.get(
    'https://api.marswave.ai/openapi/v1/speakers/list',
    headers={'Authorization': f'Bearer {os.environ["LISTENHUB_API_KEY"]}'}
)

设置环境变量

将 API Key 存为 LISTENHUB_API_KEY 环境变量,本文档所有代码示例均使用此变量名:

# 添加到 ~/.zshrc 或 ~/.bashrc
export LISTENHUB_API_KEY="your_api_key_here"

也可在项目根目录创建 .env 文件(需搭配 dotenv 等库加载):

# .env
LISTENHUB_API_KEY=your_api_key_here

安全建议

API Key 等同于你的账户凭证,泄露可能导致积分被消耗。

  • 始终使用 HTTPS
  • 不要在前端代码中暴露 API Key
  • 不要将 API Key 或 .env 文件提交到 Git 仓库
  • 使用环境变量存储 API Key

请求限制

限制项说明
创建请求频率3 RPM每分钟最多 3 次创建请求
超出限制错误码29998实现退避重试策略

查询类请求(如查询单集状态、获取音色列表)不受此限制。

下一步

On this page