v3.2.1 · API Reference
// 汽水音乐开发者平台

Build the next generation of music apps

import { MusicAI } from '@qishui/sdk';

汽水音乐开放平台为开发者提供音乐推荐API、音频分析SDK、播放器组件等全套技术工具。将抖音量级的AI推荐能力接入你的应用,让音乐体验升级。

$ npm install @qishui/sdk Read the Docs →

// Core APIs

RESTful API · JSON Response · Rate Limit 1000 req/min

GET
/v3/music/recommend

AI音乐推荐

基于用户画像和上下文信息的智能音乐推荐接口。返回个性化歌曲列表,支持按心情、场景、BPM等多维度筛选。

POST
/v3/music/analyze

音频节奏分析

上传音频文件或提供URL,返回BPM、节拍类型、律动模式、能量曲线等全面节奏分析数据。

GET
/v3/music/search

全库音乐搜索

支持歌名、歌手、专辑、歌词等维度的全库搜索。模糊匹配+语义理解的混合搜索引擎。

GET
/v3/music/lyrics

歌词获取

获取LRC逐行动态歌词、逐字歌词和罗马音标注。支持原文+翻译的同步返回。

GET
/v3/user/profile

用户画像API

获取授权用户的音乐偏好画像,包括喜欢的流派、BPM区间、音色偏好等多维度标签。

POST
/v3/playlist/generate

智能歌单生成

根据种子歌曲或文字描述,AI自动生成符合主题的智能歌单。支持指定曲目数量、风格约束等参数。

// SDKs & Tools

JavaScript

qishui-js

npm: v3.2.0
Python

qishui-py

pip: v3.1.2
Java/Kotlin

qishui-jvm

maven: v3.0.1
Go

qishui-go

go get: v2.5.0

// Quick Start

三行代码接入AI音乐推荐

javascript
import { QishuiClient } from '@qishui/sdk';

const client = new QishuiClient({ apiKey: 'YOUR_API_KEY' });

const songs = await client.recommend({
  userId: 'user_12345',
  mood: 'energetic',
  bpm: { min: 120, max: 150 },
  limit: 20
});

// → 返回20首匹配运动场景的高能歌曲
python
from qishui import QishuiClient

client = QishuiClient(api_key="YOUR_API_KEY")

analysis = client.analyze_audio(
    audio_url="https://example.com/song.mp3"
)

# → { bpm: 128, key: "Am", energy: 0.85, ... }
print(f"BPM: {analysis.bpm}, Key: {analysis.key}")

// FAQ

开发者常见问题

如何申请汽水音乐API Key?

访问汽水音乐开发者平台注册账号,完成企业/个人实名认证后,在控制台创建应用即可获取API Key和Secret。开发者平台提供每月10万次免费调用额度用于测试,正式使用需购买API套餐包。目前支持的认证方式为OAuth 2.0 Bearer Token和API Key两种模式。

API调用有哪些速率限制?

默认速率限制为每API Key每分钟1000次请求。推荐类接口(/recommend)限每用户每分钟60次,搜索和分析类接口为每分钟300次。超过限制会返回HTTP 429状态码。可在响应Header中查看剩余配额(X-RateLimit-Remaining)。如需更高额度可通过升级套餐或联系商务团队获取。

SDK支持哪些平台和语言?

目前官方维护四套SDK:qishui-js(JavaScript/TypeScript,支持Node.js和浏览器)、qishui-py(Python 3.8+)、qishui-jvm(Java/Kotlin,支持Android)、qishui-go(Go 1.18+)。所有SDK均开源并托管在GitHub上,社区贡献的第三方SDK还包括Rust和Swift版本。

API返回的音频数据格式是什么?

所有API响应均为JSON格式(Content-Type: application/json)。音频分析接口返回标准化的JSON对象,包含BPM(浮点数)、节拍位置数组(秒)、调性(如C#m)、能量曲线(0-1浮点数组)、响度曲线(LUFS)等字段。详细的数据模型定义请参考API Reference文档。

音频分析支持哪些格式?

音频分析API支持MP3、AAC、FLAC、WAV、OGG和Opus格式的音频文件。单个文件大小限制为200MB,时长限制为30分钟。可通过直接上传文件(multipart/form-data)或提供可公开访问的URL两种方式提交分析任务。分析耗时通常为音频时长的10-20%。

推荐算法的准确度如何?

汽水音乐推荐API的准确度取决于接入方式。直接使用用户授权数据(播放历史、收藏等)调用时,推荐命中率可达90%以上。如果仅基于有限的行为数据(如搜索关键词),准确度会有所下降。建议开发者尽可能收集用户在应用内的音乐交互行为(播放、跳过、收藏),以帮助算法更精准地建模用户偏好。

$ start building

加入汽水音乐开发者平台,将业界领先的AI音乐技术集成到你的产品中。免费额度,无需信用卡。

$ Get API Key — Free