API 接口概览与鉴权机制
OneASR 提供了一套标准化、高性能的 REST 与 WebSocket 接口体系，涵盖通用语音转录、实时流式识别、异步任务管理与媒体处理。
服务基础地址 (Base URL)
- 本地单机环境：
http://localhost:8000 - OpenAI 兼容端点：
http://localhost:8000/v1 - 实时 WebSocket 端点：
ws://localhost:8000/v1/realtime（或/v1/realtimeext）
身份鉴权方式
所有访问 OneASR 网关的请求均需通过 API Key 进行鉴权（在 config.yaml 中配置 api_key: sk-oneasr-...）。
支持以下三种凭证传递方式：
1. HTTP 请求头 Bearer Token（标准 OpenAI 格式）
http
Authorization: Bearer sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u2. 自定义请求头 (X-API-Key)
http
X-API-Key: sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u3. URL Query 参数（适用于 WebSocket 建立握手）
text
ws://localhost:8000/v1/realtime?api_key=sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u核心 API 功能分组
| 分组模块 | 涵盖端点 | 通信协议 | 说明 |
|---|---|---|---|
| OpenAI 兼容 | /v1/audio/transcriptions, /v1/models | HTTP REST | 零修改平替 OpenAI 语音转录与模型发现 |
| 实时流式传输 | /v1/realtime, /v1/realtimeext | WebSocket | < 160ms 块级实时双工音频流式识别 |
| 异步文件转录 | /v1/file-transcription/transcriptions | HTTP & SSE | 超长音视频（≤2GB）后台异步任务与进度推流 |
| 文件存储管理 | /v1/files/*, /v1/files/fetch-url | HTTP REST | 音频上传管理与网络音视频直链异步抓取 |
| 媒体与引擎监控 | /v1/media/parse, /v1/providers | HTTP REST | 媒体音轨提取与 ASR 引擎运行状态查询 |