API概要
エンドポイント、リクエストパラメーター、レスポンスフィールド、ストリーミングイベントを確認できます。初めて連携する場合は用途別ガイドから始め、個々のフィールドはリファレンスで確認してください。
認証
API キーを環境変数 MOSS_API_KEY に設定します。一般的な HTTP エンドポイントでは Authorization: Bearer <API Key> を使用します。
Nex N2.6 の Chat Completions と Responses は Bearer 認証を使用します。Messages と Count Tokens では x-api-key と anthropic-version: 2023-06-01 を指定します。
モデル一覧の取得リクエストで、APIキーが有効かどうかを確認できます。
curl "https://api.mosi.cn/v1/models" \
-H "Authorization: Bearer $MOSS_API_KEY"エンドポイント一覧
Nex N2.6は期間限定無料で、呼び出しで消費されるクレジットは0です。
| エンドポイント | 機能 | 同期 | 非同期 | ストリーミング |
|---|---|---|---|---|
| GET /v1/models | 現在の API キーで利用できるモデルを取得 | ✓ | — | — |
| POST /v1/chat/completions | Nex N2.6のチャット補完 | ✓ | — | ✓ |
| POST /v1/responses | Nex N2.6のテキスト生成 | ✓ | — | ✓ |
| POST /v1/messages | Nex N2.6のメッセージ生成 | ✓ | — | ✓ |
| POST /v1/messages/count_tokens | Nex N2.6 の入力トークン数を見積もる | ✓ | — | — |
| POST /v1/files | ファイルをアップロードしてファイル 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 | MOSS-VL による画像・動画理解 | ✓ | — | — |
| WSS /v1/realtime | 双方向 WebSocket 接続によるリアルタイム動画理解(ベータ) | — | — | ✓ |
| GET /v1/audio/tasks/{task_id} | 非同期音声タスクの状態または結果を取得 | ✓ | — | — |
| POST /v1/images/generations | 画像の生成。プロンプト自動改善を利用可能 | ✓ | — | — |
共通仕様
| ルール | 説明 |
|---|---|
| Base URL | HTTP のベース URL には https://api.mosi.cn を使用します。OpenAI SDK の base_url には https://api.mosi.cn/v1 を設定します。 |
| 認証 | API キーをリクエストヘッダーで渡します。「認証」の説明に従い、プロトコルに合ったヘッダーを使用します。 |
| JSONリクエスト | テキスト対話、音声合成、URL または file_id を使う文字起こし、マルチモーダル理解、画像生成では application/json を使用します。 |
| ファイルアップロード | ローカルファイルを直接アップロードする場合は multipart/form-data を使用します。フィールド名は各エンドポイントの仕様を参照してください。 |
| 同期 | エンドポイントから最終結果が返るまで接続を維持します。 |
| 非同期 | 非同期実行に対応する音声エンドポイントでは、async=true を指定してタスクを作成し、タスクを取得で結果を取得します。 |
| ストリーミング | HTTP エンドポイントでは、各エンドポイントの仕様に従って stream を指定し、返されたチャンクやイベントを処理します。リアルタイム動画理解は双方向の WebSocket イベントを使用します。 |
| エラー | 一般的なエラーはプラットフォームのエラーコードで原因を確認します。フィールドの検証やストリーミング時のエラーについては、各エンドポイントのリファレンスを参照してください。 |