API 概要と認証メカニズム
OneASR は、一般的な音声文字起こし、リアルタイムストリーミング認識、非同期タスク管理、メディア処理を網羅する、標準化された高性能な REST および WebSocket インターフェースを提供します。
サービスベース URL (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-... を設定）。
以下の 3 通りの認証情報の送信方法をサポートしています：
1. HTTP Authorization ヘッダー Bearer Token（標準 OpenAI 形式）
http
Authorization: Bearer sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u2. カスタムリクエストヘッダー (X-API-Key)
http
X-API-Key: sk-oneasr-v1-p_L3kXm9QZ8sT2vA4wE7rY1u3. URL クエリパラメータ（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 | 音声ファイルアップロード管理と Web 動画・音声直リンクの非同期取得 |
| メディア & エンジン監視 | /v1/media/parse, /v1/providers | HTTP REST | 音声トラック抽出と ASR エンジン稼働ステータス確認 |