> ## 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.

# メディアを文字起こし

> アップロード済みの音声または動画ファイルを、プレーンテキスト、段落、文に文字起こしします。Web ツールと同じプランの制限と日次利用枠が適用されます。簡潔な保存済み結果の参照を返します。完全な出力は、その getAction または downloadAction で取得してください。

アップロード済みの音声または動画ファイルを、プレーンテキスト、段落、文に文字起こしします。Web ツールと同じプランの制限と日次利用枠が適用されます。簡潔な保存済み結果の参照を返します。完全な出力は、その getAction または downloadAction で取得してください。

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

## 認証と権限

<ParamField header="x-api-key" type="string" required>
  このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
  でのみ使用でき、この REST エンドポイントでは使用できません。
</ParamField>

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

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

## パラメーター

<ParamField body="fileKey" type="string" required>
  completed のアップロードまたはメディアインポートが返す、所有する fileKey。生成のたびにアップロード済みソースが消費されます。

  最小文字数: 1. 最大文字数: 1024.
</ParamField>

<ParamField body="fileName" type="string">
  テキスト値。

  最小文字数: 1. 最大文字数: 255. パターン: `^[^/\\\r\n\0]+$`.
</ParamField>

<ParamField body="keyterms" type="array">
  値のリスト。要素の構造は完全な入力スキーマを参照してください。

  最大要素数: 100.
</ParamField>

<ParamField body="requestId" type="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}$`.
</ParamField>

<Accordion title="完全な入力スキーマ">
  以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。

  ```json theme={null}
  {
    "type": "object",
    "properties": {
      "fileKey": {
        "type": "string",
        "minLength": 1,
        "maxLength": 1024,
        "description": "An owned fileKey returned by a completed upload or media import. Each generation consumes its uploaded source."
      },
      "fileName": {
        "type": "string",
        "minLength": 1,
        "maxLength": 255,
        "pattern": "^[^/\\\\\\r\\n\\0]+$"
      },
      "keyterms": {
        "maxItems": 100,
        "type": "array",
        "items": {
          "type": "string",
          "minLength": 1,
          "maxLength": 120
        }
      },
      "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}$"
      }
    },
    "required": ["fileKey"],
    "additionalProperties": false
  }
  ```
</Accordion>

## 冪等性

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

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

## リクエスト例

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

<RequestExample>
  ```bash cURL theme={null}
  curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_create' \
    --header "x-api-key: $VOICECHEAP_API_KEY" \
    --header 'Content-Type: application/json' \
    --data '{"fileKey":"uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4","fileName":"interview.mp4","keyterms":["VoiceCheap"],"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
  ```

  ```javascript JavaScript theme={null}
  const input = {
    fileKey: 'uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4',
    fileName: 'interview.mp4',
    keyterms: ['VoiceCheap'],
    requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
  };
  const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_create', {
    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/transcription_create",
      headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
      json={"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4", "fileName": "interview.mp4", "keyterms": ["VoiceCheap"], "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"},
      timeout=120,
  )
  body = response.json()
  if not response.ok:
      raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
  print(body)
  ```
</RequestExample>

## レスポンス

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

保存済み文字起こし結果への参照。完全なJSONには transcript.raw、transcript.paragraphs、transcript.sentences、任意の transcript.detectedLanguage が含まれます。

<ResponseExample>
  ```json HTTP 202 theme={null}
  {
    "data": {
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "status": "running",
      "pollAction": "action_request_get",
      "pollAfterSeconds": 5
    },
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
  }
  ```

  ```json HTTP 200 theme={null}
  {
    "data": {
      "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
      "operation": "transcription_create",
      "createdAt": 1792152000000,
      "fileName": "voicecheap-transcription_create-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
      "byteLength": 116,
      "contentType": "application/json; charset=utf-8",
      "status": "completed",
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "getAction": "transcription_result_get",
      "downloadAction": "transcription_result_download",
      "listAction": "transcription_result_list"
    },
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
  }
  ```

  ```json HTTP 202 replay_running theme={null}
  {
    "data": {
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "operation": "transcription_create",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "running",
      "pollAfterSeconds": 5
    },
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
  }
  ```

  ```json HTTP 200 replay_completed_without_result theme={null}
  {
    "data": {
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "operation": "transcription_create",
      "createdAt": 1792144800000,
      "updatedAt": 1792144820000,
      "status": "completed",
      "resultStored": false,
      "message": "The action completed. Retrieve its output from the corresponding history or resource action."
    },
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
  }
  ```
</ResponseExample>

## 結果フィールド

| フィールド | 説明 |
| - | - |
| `data.resultId` | 所有する保存済み出力の UUID。getAction または downloadAction で使用します。requestId や各 historyId とは異なります。 |
| `data.operation` | この保存済み JSON を生成した生成アクション。 |
| `data.createdAt` | 保存済み出力を準備した時刻のUnixタイムスタンプ（ミリ秒）。 |
| `data.fileName` | JSON エクスポート用の推奨ファイル名。 |
| `data.byteLength` | コンパクトなメタデータではなく、シリアライズされた出力全体の UTF-8 バイト数。 |
| `data.contentType` | application/json; charset=utf-8。 |
| `data.status` | 生成成功時は completed。結果履歴には pending の復旧対象エントリが表示される場合もあります。 |
| `data.requestId` | 記録されている場合の、元のアクションリクエストのUUID。 |
| `data.getAction` | 所有する結果の取得アクション。includeContent のデフォルトは false です。構造化された出力全体を取得するには true が必要です。 |
| `data.downloadAction` | 認証が必要なエクスポートアクション。完全な JSON を content 文字列として返します。 |
| `data.listAction` | この権限ドメインで、ご自身が所有する保存済み出力を一覧表示するアクション。 |

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

接続が切断された後も同じ識別子を使用してください。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":"13579bdf-2468-4ace-8bdf-0123456789ab","operation":"transcription_create"}'
```

```json HTTP 200 theme={null}
{
  "data": {
    "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
    "operation": "transcription_create",
    "status": "completed",
    "createdAt": 1792144800000,
    "updatedAt": 1792144820000,
    "resultStored": true,
    "result": {
      "resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b",
      "operation": "transcription_create",
      "createdAt": 1792152000000,
      "fileName": "voicecheap-transcription_create-b3caf96f-5f2a-4619-832c-a12c0d57f78b.json",
      "byteLength": 116,
      "contentType": "application/json; charset=utf-8",
      "status": "completed",
      "requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
      "getAction": "transcription_result_get",
      "downloadAction": "transcription_result_download",
      "listAction": "transcription_result_list"
    }
  }
}
```

## 操作の注意事項

* 有料サブスクリプションとアクションの権限が必要です。実行時に、実行者の個人向けツールプランが再確認されます。認証情報がチームに関連付けられていても、保存済みツールとアップロード参照はその実行者に属します。
* 成功したアクションは、API/MCP 共通の月間呼び出し枠を1回消費します。月間上限は Beginner が 500 回、Starter が 5,000 回、Creator が 25,000 回で、Pro、Scale、Enterprise に月間上限はありません。毎分の上限はそれぞれ 30、60、120、180、300、600 回で、引き続き適用されます。ツールの生成枠は別です。
* UUID v4 の requestId、またはそれと同じ値の Idempotency-Key ヘッダーを使用し、再試行時もアクション、ID、引数を変えないでください。キャッシュからの再応答は、月間呼び出し枠を追加消費しません。
* このアクションは非同期です。最初のトランスポート結果は pollAction を含む running 状態のリクエストです。この操作名と元の requestId を指定して action\_request\_get をポーリングしてください。ここに示す完了時の操作結果は、生成本文ではなく、保存済み出力への簡潔な参照です。
* 完全な出力は、認証済みの所有者情報に紐づけて暗号化ストレージに保存され、保持量に制限のあるアクションポーリングキャッシュとは独立しています。構造化JSONを取得するには、返された getAction に resultId と includeContent: true を渡してください。JSONテキストを取得するには、downloadAction に resultId を渡します。元のリクエストのみが分かる場合は、listAction で復旧できます。
* 保存済み JSON の上限は 32 MiB です。メタデータがストレージの暗号化キーや、認証不要の文字起こしダウンロード URL を公開することはありません。
* 生成が成功すると、個人用ツールの利用枠を1回分使用確定します。生成が失敗した場合、通常はツールの予約枠を解放します。出力が永続保存されたか不明な場合は、再生成する前に同じリクエストと保存済み結果の履歴を確認してください。重複利用を防ぐため、サーバーは予約を保持します。
* 月間の連携上限がない上位プランにも、以下のツール別の日次利用枠とメディア上限は適用されます。これらの単体アクションは、吹き替え分数や TTS 文字数ではなく、各ツールの利用枠を消費します。
* ご自身が所有する完了済みアップロードまたはインポートの fileKey を使用し、一度限りの使用として扱ってください。メディア処理の開始後は、成功した場合も処理に失敗した場合も、クリーンアップで元ファイルが削除されます。処理前に検証または利用枠の確認で拒否された場合は、元ファイルが残ることがあります。別の生成を開始する前に、元の requestId を再利用して受け付け済みの生成を復旧してください。
* 対応する音声または動画を 200 MiB・2時間まで受け付けます。fileName は任意の表示用メタデータです。所有権とメディアの検証には引き続き fileKey を使用します。
* ツールごとの1日の利用枠は、生成成功回数で Beginner 5、Starter 15、Creator 30、Pro 60、Scale 100、Enterprise 100です。対応するWebツールと共有され、アカウントのツールのリセット期間を使用します。
* 個人の文字起こし履歴エントリーはベストエフォートで保存されます。ツール履歴エントリーが保存されなかった場合も、永続的な連携結果から完全な出力を復旧できます。

## 使用量

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

## エラー

| HTTP ステータス | コード | 意味または対処方法 |
| - | - | - |
| 400 | `CREDENTIAL_IN_QUERY` | access\_token または api\_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | `DURATION_TOO_LONG` | メディアの長さが、この操作の上限を超えています。 |
| 400 | `DURATION_UNKNOWN` | 実行ステップでメディアの正の長さを判定できませんでした。 |
| 400 | `FILE_TOO_LARGE` | 保存済みソースが、この操作固有のバイト数上限を超えています。 |
| 400 | `IDEMPOTENCY_CONFLICT` | ヘッダーと本文のリクエスト ID が一致しません。 |
| 400 | `INVALID_FILE_TYPE` | ファイル名の拡張子は、この操作でサポートされていません。 |
| 400 | `INVALID_MEDIA_DURATION` | 解析で取得したソースの長さがない、不正、またはプランの長さ制限を超えています。 |
| 400 | `INVALID_MEDIA_STREAM` | ソースに文字起こしに使用できる音声ストリームがありません。 |
| 400 | `INVALID_REQUEST_ID` | requestId または Idempotency-Key が UUID v4 ではありません。 |
| 400 | `VALIDATION_ERROR` | 引数がアクションのスキーマを満たしていないか、不明な引数が指定されています。 |
| 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` | APIキーまたはMCP接続に、必要なアクション権限がありません。 |
| 403 | `INTEGRATION_PLAN_UNSUPPORTED` | アカウントの連携上限を確認できませんでした。 |
| 403 | `INVALID_FILE_REFERENCE` | fileKey は、実行者が所有する有効な完了済みアップロード参照ではありません。 |
| 403 | `PAID_SUBSCRIPTION_REQUIRED` | このツールアクションの実行時点で、認証済み実行者の有料サブスクリプションが有効ではありません。 |
| 403 | `SUBSCRIPTION_REQUIRED` | 有効な有料サブスクリプションを使用してください。 |
| 403 | `TEAM_OWNER_NOT_FOUND` | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | `MEDIA_NOT_FOUND` | completed のソースアップロードが存在しないか、空です。以前の生成で消費された可能性があります。 |
| 409 | `CONCURRENT_ACTION_LIMIT_REACHED` | このアカウントでは、すでに 10 件の連携アクションが実行中です。新しいアクションを開始する前に、既存のリクエストをポーリングしてください。 |
| 409 | `IDEMPOTENCY_CONFLICT` | 識別子を再利用する場合は、同じ操作と引数でのみ使用してください。 |
| 410 | `TOOL_RESULT_ACCOUNT_UNAVAILABLE` | 実行者のアカウントは削除中か、すでに存在しないため、永続的な結果を保存できません。 |
| 413 | `TOOL_RESULT_TOO_LARGE` | 生成された完全なJSONが 32 MiB を超えており、連携結果として保存できません。 |
| 422 | `TRANSCRIPTION_EMPTY` | 音声が無音か、会話が検出されませんでした。 |
| 429 | `INTEGRATION_MONTHLY_LIMIT_REACHED` | 使用済みと処理待ちの呼び出し数が、共有の月間 API/MCP 利用枠に達しました。 |
| 429 | `INTEGRATION_RATE_LIMIT_REACHED` | アカウントの毎分の連携上限に達しています。retryAfterSeconds を確認してください。 |
| 429 | `TRANSCRIPTION_TOOL_DAILY_LIMIT_REACHED` | 実行者が文字起こしツールの1日の利用枠を使い切りました。 |
| 500 | `INTERNAL_ERROR` | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 502 | `INTERNAL_ERROR` | 生成または出力の保存に失敗しました。別の生成を開始する前に、元のリクエストと保存済み結果の履歴を確認してください。 |
| 503 | `ACTION_RESULT_UNAVAILABLE` | アクションは実行されましたが、リクエスト結果の永続保存を確認できませんでした。別の書き込みを開始する前に、同じアクションと requestId をポーリングし、リソースの履歴を確認してください。 |
| 503 | `INTERNAL_ERROR` | 生成または保存済み結果の永続保存の結果が不確定、または一時的に利用できません。再生成する前に、認証付きの結果復元を使用してください。 |
| 503 | `SERVER_RESTARTING` | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |

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


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