APIリファレンス
はじめに
最初のAPIリクエストを行うために必要なものすべて
ベースURL
Moknah は、ユースケースに応じて2種類のエンドポイントを提供しています。
標準 REST API (個別のリクエスト向けに):
https://moknah.io/api/v1/
リアルタイムWebSocket API (継続的なストリーミングのために):
wss://moknah.io/api/v1/
認証
Moknah APIは〜を使用します APIキー 認証用。APIキーを~に含めてください。 Authorization ~を使用したヘッダー
所持人 すべてのHTTPリクエストおよびWebSocketハンドシェイクにおけるスキーム
Authorization: Bearer YOUR_API_KEY
APIキーの取得
- ~にログインする Moknah ダッシュボード
- Proプランに登録するか、お問い合わせください 営業 エンタープライズアクセス用
- ~へ移動する API
- クリック APIキーの管理
- クリック 新しいキー
- キーをコピーし、安全に保管してください。
鍵を安全に保管してください
APIキーをクライアントサイドのコードや公開リポジトリに決して公開しないでください。パスワードと同様に扱ってください。
HTTPの簡単な例
標準のREST APIを使用してテキストから音声を生成する完全な例を以下に示します。
curl -X POST "https://moknah.io/api/v1/tts/generate/" \
-H "Authorization: Bearer your_api_key" \
-H "Content-Type: application/json" \
-d '{
"text": "مرحبا بك في منصة مكنة",
"voice_id": 1
}' \
--output speech.mp3
import requests
response = requests.post(
"https://moknah.io/api/v1/tts/generate/",
headers={
"Authorization": f"Bearer your_api_key",
},
json={
"text": "مرحبا بك في منصة مكنة",
"voice_id": 1
}
)
if response.status_code == 200:
with open("speech.mp3", "wb") as f:
f.write(response.content)
print("音声を保存しました!")
else:
print(f"エラー: {response.json()}")
const response = await fetch(
'https://moknah.io/api/v1/tts/generate/',
{
method: 'POST',
headers: {
'Authorization': 'Bearer your_api_key',
'Content-Type': 'application/json'
},
body: JSON.stringify({
text: 'مرحبا بك في منصة مكنة',
voice_id: 1
})
}
);
if (response.ok) {
const blob = await response.blob();
// オーディオBlobを使用してください
console.log("音声が生成されました!");
} else {
const error = await response.json();
console.error(error);
}
応答形式
成功時のレスポンス
成功時のレスポンスはエンドポイントによって異なります。
- TTS生成 (POST): 要求された output_format(デフォルトは audio/mpeg)で、完全なバイナリオーディオデータを返します。
- TTSストリーム (WSS): 生成されるMP3のバイナリチャンクを継続的にストリーミングします。
- その他のエンドポイント: 構造化されたJSONデータを返します
レート制限ヘッダー (HTTPのみ)
すべてのHTTPレスポンスには、レート制限に関する情報が含まれています(WebSocketの場合は、接続を閉じることで制限が適用されます)。
| ヘッダー | 説明 |
|---|---|
| RateLimit-Limit | 1分あたりの最大リクエスト数 |
| RateLimit-Remaining | 現在のウィンドウで残っているリクエスト |
| RateLimit-Reset | 制限がリセットされるUnixタイムスタンプ |
| Moknah-Credits-Remaining | お客様のクレジット残高 |
一般的なエラーコード
| コード | タイプ | 説明 |
|---|---|---|
| 400 | INVALID_REQUEST |
無効なパラメータまたは不正な形式のJSON |
| 401 | UNAUTHORIZED |
APIキーが無効か、または指定されていません。 |
| 402 | INSUFFICIENT_CREDITS |
アカウントのクレジットが不足しています |
| 429 | RATE_LIMIT_EXCEEDED |
リクエストが多すぎます (HTTP) |
| 4290 | CONCURRENT_LIMIT |
アクティブな接続が多すぎます (WSS) |
| 500 | INTERNAL_SERVER_ERROR |
サーバーエラー |
詳細はこちら
~を見る エラー 詳細なエラー処理ガイダンスが記載されたページ
今後のステップ
セットアップが完了しましたので、利用可能なエンドポイントを確認してみましょう。
投稿
音声の一覧を表示
TTSで利用可能な音声を取得する
投稿
音声を生成する
テキストを音声に変換する
WSS
ストリーム・スピーチ
リアルタイムWebSocket TTS
投稿
音声を文字に起こす
音声ファイルからテキストを抽出する
WSS
ストリームの文字起こし
リアルタイムWebSocket STT
APIサポート
APIに関するご質問や問題については、こちらまでお問い合わせください。 api@moknah.io.