> ## Documentation Index
> Fetch the complete documentation index at: https://api-docs.voicecheap.ai/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# 音声の単語時間情報を取得

> ご自身が所有する生成音声の単語タイムスタンプを準備または取得します。ready、processing、unavailable のいずれかを返します。完了したアラインメントはキャッシュされます。

ご自身が所有する生成音声の単語タイムスタンプを準備または取得します。ready、processing、unavailable のいずれかを返します。完了したアラインメントはキャッシュされます。

```http theme={null}
POST https://api.voicecheap.ai/v1/actions/tts_align
```

## 認証と権限

**x-api-key** `string` *required*

このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。

必要な権限: `tts:write`.

有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。

## パラメーター

**requestId** `string`

トランスポート境界では任意です。省略すると、検証前にサーバーが識別子を補完します。レスポンスを受信できなかった場合に安全に復旧できるよう、固定の UUID v4 を指定してください。

形式: "uuid". パターン: `^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$`.

**historyId** `string` *required*

tts\_generate または tts\_list が返す履歴ID。

パターン: `^(free-)?[0-9a-f]{64}$`.

> [accordion] 完全な入力スキーマ
>
> 以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
>
> ```json theme={null}
> {
>   "type": "object",
>   "properties": {
>     "requestId": {
>       "description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries.",
>       "type": "string",
>       "format": "uuid",
>       "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$"
>     },
>     "historyId": {
>       "type": "string",
>       "pattern": "^(free-)?[0-9a-f]{64}$",
>       "description": "History ID returned by tts_generate or tts_list."
>     }
>   },
>   "required": ["historyId"],
>   "additionalProperties": false
> }
> ```

## 冪等性

変更操作ごとに、requestId または Idempotency-Key HTTP ヘッダーに UUID v4 を指定してください。ネットワーク障害後の再試行では、同じ識別子と同一の引数を使用します。両方を指定する場合は一致させる必要があります。保存済みリクエストを再取得しても、操作は再実行されず、月間呼び出し回数も追加で消費されません。失敗または中断したリクエストは自動的には再開されません。

すべての変更操作は、再試行時に同じリクエストがまだ実行中であれば、通常の初回実行が同期処理であっても HTTP 202 を返す場合があります。実行が完了していても resultStored が false の場合、再試行では元の結果ではなく、保存済みリクエストの状態を HTTP 200 で返します。出力は対応するドメインの履歴、結果、またはダウンロードアクションで取得してください。

## リクエスト例

例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。

```bash cURL theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/tts_align' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","historyId":"722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"}'
```

```javascript JavaScript theme={null}
const input = {
  requestId: '284a861a-4da8-4d67-ad48-8123e76c8e91',
  historyId: '722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tts_align', {
  method: 'POST',
  headers: {
    'x-api-key': process.env.VOICECHEAP_API_KEY,
    'Content-Type': 'application/json',
  },
  body: JSON.stringify(input),
});
const body = await response.json();
if (!response.ok) throw new Error(body.code + ': ' + body.message);
console.log(body);
```

```python Python theme={null}
import os
import requests

response = requests.post(
    "https://api.voicecheap.ai/v1/actions/tts_align",
    headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
    json={"requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91", "historyId": "722c80c6412edd4c3dcd625061e1c1feafbb0d54274d95fd8b5ca047f8cdd23d"},
    timeout=120,
)
body = response.json()
if not response.ok:
    raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
```

## レスポンス

この操作は実行中に HTTP 202 を返します。requestId を保存し、その識別子と元の操作名を指定して action\_request\_get をポーリングしてください。ポーリングの状態は running、completed、failed、interrupted です。完了した結果が別のメディアジョブを示す場合は、その操作に対応するステータスまたは出力取得アクションで処理を続けてください。

所有する読み上げ音声のアライメント状態と単語タイムスタンプ。

```json HTTP 202 theme={null}
{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "status": "running",
    "pollAction": "action_request_get",
    "pollAfterSeconds": 5
  },
  "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```

```json HTTP 200 theme={null}
{
  "data": {
    "status": "ready",
    "wordAlignment": [
      {
        "text": "Hello",
        "startSeconds": 0,
        "endSeconds": 0.6,
        "sourceStartCharacterIndex": 0,
        "sourceEndCharacterIndex": 5
      },
      {
        "text": "world.",
        "startSeconds": 0.7,
        "endSeconds": 1.4,
        "sourceStartCharacterIndex": 6,
        "sourceEndCharacterIndex": 12
      }
    ]
  },
  "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```

```json HTTP 202 replay_running theme={null}
{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "tts_align",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "running",
    "pollAfterSeconds": 5
  },
  "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```

```json HTTP 200 replay_completed_without_result theme={null}
{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "tts_align",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "status": "completed",
    "resultStored": false,
    "message": "The action completed. Retrieve its output from the corresponding history or resource action."
  },
  "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91"
}
```

## 結果フィールド

| フィールド | 説明 |
| - | - |
| `data.status` | ready、processing、または unavailable。 |
| `data.wordAlignment` | 単語のタイムスタンプ。アラインメントが利用できない場合は null。 |
| `data.wordAlignment[].text` | アラインメント済みの単語テキスト。 |
| `data.wordAlignment[].startSeconds` | 単語の開始時刻（秒）。 |
| `data.wordAlignment[].endSeconds` | 単語の終了時刻。秒単位。 |
| `data.wordAlignment[].sourceStartCharacterIndex` | 読み上げ制御タグを除去した後の spokenText 内の開始文字インデックス。 |
| `data.wordAlignment[].sourceEndCharacterIndex` | 話し方の制御タグを除去した後の spokenText における、終了文字インデックス。 |

## リクエストの復旧とポーリング

接続が切断された後も同じ識別子を使用してください。resultStored が false の場合は、対応する履歴、結果、またはダウンロードアクションで出力を取得します。進捗を確認するためだけに、別の生成を開始しないでください。

```bash theme={null}
curl --request POST 'https://api.voicecheap.ai/v1/actions/action_request_get' \
  --header "x-api-key: $VOICECHEAP_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{"requestId":"284a861a-4da8-4d67-ad48-8123e76c8e91","operation":"tts_align"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "284a861a-4da8-4d67-ad48-8123e76c8e91",
    "operation": "tts_align",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "status": "ready",
      "wordAlignment": [
        {
          "text": "Hello",
          "startSeconds": 0,
          "endSeconds": 0.6,
          "sourceStartCharacterIndex": 0,
          "sourceEndCharacterIndex": 5
        },
        {
          "text": "world.",
          "startSeconds": 0.7,
          "endSeconds": 1.4,
          "sourceStartCharacterIndex": 6,
          "sourceEndCharacterIndex": 12
        }
      ]
    }
  }
}
```

## 操作の注意事項

* この変更操作には UUID v4 requestId を使用し、再試行時も同じ引数で再利用してください。長時間実行アクションは最初に running のリクエストを返します。この例は、action\_request\_get で取得できる完了済みハンドラー結果です。
* status は、タイムスタンプがある場合は ready、別のアラインメント処理が実行中なら processing、現在アラインメントを作成できない場合は unavailable です。processing と unavailable は wordAlignment: null を返します。
* 成功済みのアライメントはキャッシュされます。アプリのプレビューでは、スクリプトの実際に再生される部分のみをアライメントします。プレビューを完全版にするには、新しい全体音声のアライメントが必要です。
* ソースの文字インデックスは、tts\_get が返す、対応する発話制御タグを除去した spokenText を参照します。
* processing を返して完了したアクションリクエストは、冪等な再実行でも記録済みの結果を維持します。利用可能なタイムスタンプは tts\_get で確認するか、実行中のアライメントが完了してから新しい requestId でアライメント確認を開始してください。
* 読み上げ履歴とカスタム音声は認証済みアカウントに属します。チームの請求設定によって、他のメンバーの読み上げや音声へのアクセス権が付与されることはありません。

## 使用量

正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。

## エラー

| HTTP ステータス | コード | 意味または対処方法 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | access\_token または api\_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | `IDEMPOTENCY_CONFLICT` | Idempotency-Key ヘッダーとリクエストボディの requestId は一致させる必要があります。 |
| 400 | `INVALID_REQUEST_ID` | UUID v4 の requestId または Idempotency-Key を指定してください。 |
| 400 | `VALIDATION_ERROR` | 入力がアクションスキーマと一致しません。フィールドエラーは details を確認してください。 |
| 401 | `API_KEY_EXPIRED` | API キーの有効期限が切れています。 |
| 401 | `INVALID_API_KEY` | 有効期限内の有効な API キーを指定してください。 |
| 401 | `INVALID_CREDENTIAL` | Authorization ヘッダーの形式が不正、または x-api-key と競合しています。 |
| 401 | `MISSING_CREDENTIAL` | 利用可能なヘッダー認証情報が指定されていないか、4096文字を超えています。 |
| 401 | `USER_NOT_FOUND` | 認証情報に対応するアカウントはすでに存在しません。 |
| 403 | `ACCOUNT_UNAVAILABLE` | 操作を実行するアカウントまたは請求対象アカウントが利用できないか、削除中です。 |
| 403 | `AMBIGUOUS_TEAM_API_KEY` | 認証情報のユーザーが複数のチームに属しているため、課金コンテキストが曖昧です。 |
| 403 | `INSUFFICIENT_SCOPE` | 必要な権限をすべて付与するか、別の認証情報を使用してください。 |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | アカウントの連携上限を確認できませんでした。 |
| 403 | `SUBSCRIPTION_REQUIRED` | 有効な有料サブスクリプションを使用してください。 |
| 403 | `TEAM_OWNER_NOT_FOUND` | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | `TEXT_TO_SPEECH_HISTORY_NOT_FOUND` | 音声履歴項目が存在しないか、別のアカウントに属しています。 |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | このアカウントでは、すでに 10 件の連携アクションが実行中です。新しいアクションを開始する前に、既存のリクエストをポーリングしてください。 |
| 409 | `IDEMPOTENCY_CONFLICT` | 識別子を再利用する場合は、同じ操作と引数でのみ使用してください。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 月次リセットを待つか、プランを変更してください。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | `INTERNAL_ERROR` | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | `ACTION_RESULT_UNAVAILABLE` | アクションは実行されましたが、結果を保存できませんでした。新しい生成を開始する前に、保存済みリクエストの状態とリソース履歴を確認してください。 |
| 503 | `SERVER_RESTARTING` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |

```json theme={null}
{
  "code": "INSUFFICIENT_SCOPE",
  "message": "This credential does not permit the requested action.",
  "status": 403,
  "details": {
    "requiredScopes": ["tts:write"]
  }
}
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.