コンソール

API概要

APIリファレンスでは、Moss APIのエンドポイント、リクエストパラメータ、戻り値、ストリーミングイベント、共通ルールを確認できます。業務への組み込みは、まずシナリオガイドを参照することをおすすめします。フィールドレベルの実装は、対応するリファレンスページの記載に従ってください。

認証

すべてのリクエストで、リクエストヘッダーにBearer Tokenを付与します。キーは環境変数としてエクスポートし、コードリポジトリには書き込まないでください。

cURL
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 URLhttps://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の双方向イベントでやり取りします。
エラー同期エラーはプラットフォーム共通のエラー構造を使用します。フィールドレベルのエラーは、各エンドポイントのリクエストパラメータの説明に従います。