API ドキュメント
koee API v1 — あなたの声モデルをアプリに組み込めます
認証
全てのAPIリクエストにはAPIキーが必要です。設定画面からキーを発行できます。
Authorization: Bearer vf_your_api_key_here
Standard プラン以上で API を利用できます。
POST
/api/v1/generateテキストから音声を生成します。
リクエストボディ
| パラメータ | 型 | 必須 | 説明 |
|---|---|---|---|
| text | string | はい | 読み上げるテキスト（最大5,000文字） |
| model_id | string | いいえ | 声モデルID。省略時はデフォルトモデルを使用 |
| mode | string | いいえ | "lite" または "pro"。デフォルト: "lite" |
レスポンス
成功時: audio/wav 形式の音声ファイル
エラー時: JSON
使用例
cURL
curl -X POST https://koee.com/api/v1/generate \
-H "Authorization: Bearer vf_your_api_key" \
-H "Content-Type: application/json" \
-d '{"text": "こんにちは、koeeです。"}' \
--output output.wav
Python
import requests
response = requests.post(
"https://koee.com/api/v1/generate",
headers={"Authorization": "Bearer vf_your_api_key"},
json={"text": "こんにちは、koeeです。"}
)
with open("output.wav", "wb") as f:
f.write(response.content)
JavaScript
const response = await fetch(
"https://koee.com/api/v1/generate",
{
method: "POST",
headers: {
"Authorization": "Bearer vf_your_api_key",
"Content-Type": "application/json",
},
body: JSON.stringify({
text: "こんにちは、koeeです。"
}),
}
);
const audioBlob = await response.blob();
APIキー管理
POST
/api/v1/keysキーを作成GET
/api/v1/keysキー一覧DELETE
/api/v1/keysキーを無効化※ キー管理エンドポイントはセッション認証（ログイン状態）が必要です。
制限
| プラン | 月間生成回数 | レート制限 | 最大文字数/回 |
|---|---|---|---|
| Standard | 100回 | 30 req/min | 5,000文字 |
| Pro | 500回 | 60 req/min | 5,000文字 |
| Business | 無制限 | 120 req/min | 5,000文字 |
エラーコード
| コード | 説明 |
|---|---|
| 401 | APIキーが無効または未指定 |
| 400 | リクエスト不正（テキスト未指定、文字数超過等） |
| 429 | レート制限超過 |
| 500 | サーバーエラー |