API ドキュメント

3 ステップで音声を生成できます:

1. ダッシュボードで API キーを発行
2. POST /api/v1/synthesize を叩く
3. レスポンスの音声バイナリを保存・再生

curl -X POST https://yomiage.cloud/api/v1/synthesize \
  -H "Authorization: Bearer yom_live_xxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "こんにちは、読み上げクラウド です。",
    "voice": "ja-JP-Chirp3-HD-Aoede"
  }' \
  --output hello.mp3

すべての API リクエストには Authorization ヘッダーで API キーを送信します:

Authorization: Bearer yom_live_xxxxxxxxxxxxxxxxxxxxxx

API キーは ダッシュボードのキー管理画面 から発行できます。

テキストから音声を生成します。

リクエストボディ (JSON)

レスポンス

成功時: 音声バイナリ（audio/mpeg または audio/wav）

エラー時: JSON

{
  "error": "monthly_limit_exceeded",
  "message": "Monthly character limit (50000) exceeded.",
  "limit": 50000,
  "used": 100013,
  "remaining": 0
}

レスポンスヘッダー

利用可能な音声の一覧を取得します。

curl https://yomiage.cloud/api/v1/voices \
  -H "Authorization: Bearer yom_live_xxxxxxxxxxxxxxxxxxxxxx"

{
  "voices": [
    {
      "engine": "google",
      "id": "ja-JP-Chirp3-HD-Aoede",
      "name": "ja-JP-Chirp3-HD-Aoede",
      "group": "Chirp3-HD",
      "gender": "FEMALE"
    },
    ...
  ]
}

現在は月間文字数のみで制限しており、秒間 / 分間のリクエスト制限はありません。

大量のリクエスト（毎秒 100 件以上）を継続的に送る場合は、事前に business@yomiage.cloud までご連絡ください。

1 リクエストあたりの上限: 5,000 字

text フィールドの最大長は 5,000 字です。 これを超えると HTTP 400 / error: "text_too_long" が返ります。

5,000 字超の場合の対処

5,000 字を超える長文（ブログ記事全文、台本、書籍など）は、クライアント側で文単位に分割して複数回リクエストし、生成した音声を連結してください。

Python サンプル（10,000+ 字を一括音声化）

import os
import requests

API_KEY = os.environ["YOMIAGE_API_KEY"]
ENDPOINT = "https://yomiage.cloud/api/v1/synthesize"
MAX_CHARS_PER_REQUEST = 4500  # 5,000 の安全マージン

def chunk_japanese_text(text: str, max_chars: int = MAX_CHARS_PER_REQUEST) -> list[str]:
    """日本語テキストを「。」優先で安全に分割。max_chars 以下のチャンクに分ける。"""
    chunks = []
    current = ""
    for sentence in text.replace("\n", "").split("。"):
        if not sentence:
            continue
        candidate = current + sentence + "。"
        if len(candidate) > max_chars and current:
            chunks.append(current)
            current = sentence + "。"
        else:
            current = candidate
    if current.strip():
        chunks.append(current)
    return chunks

def synthesize_long(text: str, voice: str = "ja-JP-Chirp3-HD-Aoede",
                    output_path: str = "output.mp3") -> None:
    """長文テキストを音声化（自動分割 + 連結）"""
    chunks = chunk_japanese_text(text)
    print(f"Splitting into {len(chunks)} chunks")
    with open(output_path, "wb") as f:
        for i, chunk in enumerate(chunks):
            res = requests.post(
                ENDPOINT,
                json={"text": chunk, "voice": voice},
                headers={"Authorization": f"Bearer {API_KEY}"},
            )
            res.raise_for_status()
            f.write(res.content)
            print(f"  [{i+1}/{len(chunks)}] {len(chunk)} chars → ok")
    print(f"Done: {output_path}")

# 使用例
long_text = open("article.txt").read()  # 10,000+ 字
synthesize_long(long_text)

Node.js サンプル

import fs from "fs";
import path from "path";

const API_KEY = process.env.YOMIAGE_API_KEY;
const ENDPOINT = "https://yomiage.cloud/api/v1/synthesize";
const MAX_CHARS = 4500;

function chunkJapaneseText(text, maxChars = MAX_CHARS) {
  const chunks = [];
  let current = "";
  for (const sentence of text.replace(/\n/g, "").split("。")) {
    if (!sentence) continue;
    const candidate = current + sentence + "。";
    if (candidate.length > maxChars && current) {
      chunks.push(current);
      current = sentence + "。";
    } else {
      current = candidate;
    }
  }
  if (current.trim()) chunks.push(current);
  return chunks;
}

export async function synthesizeLong(text, {
  voice = "ja-JP-Chirp3-HD-Aoede",
  outputPath = "output.mp3",
} = {}) {
  const chunks = chunkJapaneseText(text);
  console.log(`Splitting into ${chunks.length} chunks`);

  const buffers = [];
  for (let i = 0; i < chunks.length; i++) {
    const res = await fetch(ENDPOINT, {
      method: "POST",
      headers: {
        "Content-Type": "application/json",
        Authorization: `Bearer ${API_KEY}`,
      },
      body: JSON.stringify({ text: chunks[i], voice }),
    });
    if (!res.ok) throw new Error(`Chunk ${i+1} failed: ${res.status}`);
    const buf = Buffer.from(await res.arrayBuffer());
    buffers.push(buf);
    console.log(`  [${i+1}/${chunks.length}] ${chunks[i].length} chars → ok`);
  }

  fs.writeFileSync(outputPath, Buffer.concat(buffers));
  console.log(`Done: ${outputPath}`);
}

// 使用例
const longText = fs.readFileSync("article.txt", "utf-8");
await synthesizeLong(longText);

FAQ

Node.js (axios)

import axios from "axios";
import fs from "fs";

const response = await axios.post(
  "https://yomiage.cloud/api/v1/synthesize",
  {
    text: "こんにちは、読み上げクラウド です。",
    voice: "ja-JP-Chirp3-HD-Aoede",
  },
  {
    headers: {
      Authorization: `Bearer ${process.env.YOMIAGE_API_KEY}`,
    },
    responseType: "arraybuffer",
  },
);

fs.writeFileSync("hello.mp3", response.data);

Python (requests)

import os
import requests

response = requests.post(
    "https://yomiage.cloud/api/v1/synthesize",
    json={
        "text": "こんにちは、読み上げクラウド です。",
        "voice": "ja-JP-Chirp3-HD-Aoede",
    },
    headers={"Authorization": f"Bearer {os.environ['YOMIAGE_API_KEY']}"},
)
response.raise_for_status()

with open("hello.mp3", "wb") as f:
    f.write(response.content)

cURL（ダウンロード付き）

curl -X POST https://yomiage.cloud/api/v1/synthesize \
  -H "Authorization: Bearer $YOMIAGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"text":"こんにちは","voice":"ja-JP-Chirp3-HD-Aoede"}' \
  --output hello.mp3