API概要
APIリファレンスでは、Moss APIのエンドポイント、リクエストパラメータ、戻り値、ストリーミングイベント、共通ルールを確認できます。業務への組み込みは、まずシナリオガイドを参照することをおすすめします。フィールドレベルの実装は、対応するリファレンスページの記載に従ってください。
認証
すべてのリクエストで、リクエストヘッダーにBearer Tokenを付与します。キーは環境変数としてエクスポートし、コードリポジトリには書き込まないでください。
curl "https://api.mosi.cn/v1/models" \
-H "Authorization: Bearer $MOSS_API_KEY"エンドポイント一覧
| エンドポイント | 機能 | 同期 | 非同期 | ストリーミング |
|---|---|---|---|---|
| GET /v1/models | 利用可能なモデル一覧の取得 | ✓ | - | - |
| POST /v1/files | ファイルをアップロードしてfile_idを取得 | ✓ | - | - |
| GET /v1/files | ファイル一覧の取得 | ✓ | - | - |
| GET /v1/files/{file_id} | ファイル詳細の取得 | ✓ | - | - |
| DELETE /v1/files/{file_id} | ファイルの削除 | ✓ | - | - |
| POST /v1/audio/speech | 単一話者のテキスト音声変換。非ストリーミングとストリーミングに対応 | ✓ | ✓ | ✓ |
| POST /v1/audio/speech/speakers | 複数話者の対話音声生成 | ✓ | ✓ | - |
| POST /v1/audio/transcriptions | 音声文字起こし | ✓ | ✓ | ✓ |
| GET /v1/audio/voices | ボイス一覧の取得 | ✓ | - | - |
| POST /v1/audio/voices | ボイスの作成 | ✓ | - | - |
| POST /v1/audio/voice/generations | ボイスの生成 | ✓ | ✓ | - |
| POST /v1/responses | マルチモーダル理解 | ✓ | - | - |
| WSS /v1/realtime | リアルタイム動画理解。WebSocketの双方向イベント(Beta) | - | - | ✓ |
| GET /v1/audio/tasks/{task_id} | タスクの取得 | ✓ | - | - |
| POST /v1/images/generations | 画像生成 | ✓ | - | - |
共通ルール
| ルール | 説明 |
|---|---|
| Base URL | https://api.mosi.cn |
| 認証 | すべてのリクエストはAuthorization: Bearer $MOSS_API_KEYで認証します。 |
| JSONリクエスト | 音声生成、音声文字起こし(file_id / URL)、マルチモーダル理解、画像生成などのエンドポイントはapplication/jsonを使用します。 |
| ファイルアップロード | ローカルファイルのアップロードにはmultipart/form-dataを使用し、フィールド名は各エンドポイントの説明に従って指定します。 |
| 同期 | リクエストは接続を維持し、処理完了後に結果を直接返します。 |
| 非同期 | 時間のかかる音声タスクはasync=trueを渡してタスクを作成し、GET /v1/audio/tasks/{task_id}で照会できます。 |
| ストリーミング | HTTPストリーミングのエンドポイントは、リクエストパラメータでstreamと返却形式を明示します。リアルタイム動画理解はSSEではなく、WebSocketの双方向イベントでやり取りします。 |
| エラー | 同期エラーはプラットフォーム共通のエラー構造を使用します。フィールドレベルのエラーは、各エンドポイントのリクエストパラメータの説明に従います。 |