curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_result_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b"}'
const input = {
resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_result_download', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/transcription_result_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"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",
"content": "{\"transcript\":{\"raw\":\"Hello world.\",\"paragraphs\":\"Hello world.\",\"sentences\":\"Hello world.\",\"detectedLanguage\":\"en\"}}"
}
}
文字起こし
保存済み文字起こしアクションの結果をエクスポート
ご自身が所有する完全な結果を、ファイル名とコンテンツタイプ付きの JSON テキストとしてエクスポートします。アクセスには引き続き認証が必要です。公開メディア URL から文字起こしが公開されることはありません。
POST
/
v1
/
actions
/
transcription_result_download
curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_result_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b"}'
const input = {
resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_result_download', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/transcription_result_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"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",
"content": "{\"transcript\":{\"raw\":\"Hello world.\",\"paragraphs\":\"Hello world.\",\"sentences\":\"Hello world.\",\"detectedLanguage\":\"en\"}}"
}
}
ご自身が所有する完全な結果を、ファイル名とコンテンツタイプ付きの JSON テキストとしてエクスポートします。アクセスには引き続き認証が必要です。公開メディア URL から文字起こしが公開されることはありません。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/transcription_result_download
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
transcription:read.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
string
必須
テキスト値。形式: “uuid”. パターン:
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$.完全な入力スキーマ
完全な入力スキーマ
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
{
"type": "object",
"properties": {
"resultId": {
"type": "string",
"format": "uuid",
"pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
}
},
"required": ["resultId"],
"additionalProperties": false
}
リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。curl --request POST 'https://api.voicecheap.ai/v1/actions/transcription_result_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"resultId":"b3caf96f-5f2a-4619-832c-a12c0d57f78b"}'
const input = {
resultId: 'b3caf96f-5f2a-4619-832c-a12c0d57f78b',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/transcription_result_download', {
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);
import os
import requests
response = requests.post(
"https://api.voicecheap.ai/v1/actions/transcription_result_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"resultId": "b3caf96f-5f2a-4619-832c-a12c0d57f78b"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 保存済みの出力メタデータ。認証付きのローカルエクスポート用に、生成された完全な JSON が content 文字列としてシリアライズされます。{
"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",
"content": "{\"transcript\":{\"raw\":\"Hello world.\",\"paragraphs\":\"Hello world.\",\"sentences\":\"Hello world.\",\"detectedLanguage\":\"en\"}}"
}
}
結果フィールド
| フィールド | 説明 |
|---|---|
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 | この権限ドメインで、ご自身が所有する保存済み出力を一覧表示するアクション。 |
data.content | 元の公開生成結果全体を JSON テキストにエンコードしたもの。fileName のファイルに保存できます。 |
操作の注意事項
- 有料サブスクリプションとアクションの権限が必要です。実行時に、実行者の個人向けツールプランが再確認されます。認証情報がチームに関連付けられていても、保存済みツールとアップロード参照はその実行者に属します。
- 成功したアクションは、API/MCP 共通の月間呼び出し枠を1回消費します。月間上限は Beginner が 500 回、Starter が 5,000 回、Creator が 25,000 回で、Pro、Scale、Enterprise に月間上限はありません。毎分の上限はそれぞれ 30、60、120、180、300、600 回で、引き続き適用されます。ツールの生成枠は別です。
- resultId は、completed の生成の参照、またはこのドメインの result_list で取得する UUID です。アクションの requestId や Web ツールの historyId とは異なります。
- 結果は認証済みの実行者と権限ドメインに属します。subtitles の結果は transcription アクションで読み取れず、その逆も同様です。
- 保存済み JSON 全体は保存時に暗号化され、保持期間が限られたアクションポーリング用キャッシュとは独立して保持されます。取得には引き続き認証が必要で、文字起こしや字幕の公開 JSON URL は発行されません。
- これらのアクションは既存の出力を取得するため、メディアを生成せず、1日の利用枠も消費しません。ただし、取得が成功するたびに月間連携呼び出しを1回消費します。
- pending のメタデータは、出力の永続化に復旧が必要であることを示します。内容の読み取りまたはダウンロードにより、保存済みの暗号化オブジェクトからの復旧を試みます。別の生成を開始する前に確認してください。
- content を UTF-8 で fileName に書き込むか、JSON.parse(content) で構造化された出力を復元してください。外側のレスポンスに result プロパティやメディアのダウンロード URL はありません。
- byteLength は content 内の UTF-8 JSON のバイト数を表します。contentType は application/json; charset=utf-8 です。ダウンロード時には、保留中の暗号化された出力の復元も試みます。
使用量
正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。エラー
| HTTP ステータス | コード | 意味または対処方法 |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | access_token または api_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 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 | AMBIGUOUS_TEAM_API_KEY | 認証情報のユーザーが複数のチームに属しているため、課金コンテキストが曖昧です。 |
| 403 | INSUFFICIENT_SCOPE | APIキーまたはMCP接続に、必要なアクション権限がありません。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | アカウントの連携上限を確認できませんでした。 |
| 403 | PAID_SUBSCRIPTION_REQUIRED | このツールアクションの実行時点で、認証済み実行者の有料サブスクリプションが有効ではありません。 |
| 403 | SUBSCRIPTION_REQUIRED | 有効な有料サブスクリプションを使用してください。 |
| 403 | TEAM_OWNER_NOT_FOUND | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | TOOL_RESULT_NOT_FOUND | 結果が存在しない、別の実行者が所有している、または別の権限ドメインに属しています。 |
| 410 | TOOL_RESULT_ACCOUNT_UNAVAILABLE | 復元時に、実行者のアカウントが削除中、またはすでに存在しません。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 使用済みと処理待ちの呼び出し数が、共有の月間 API/MCP 利用枠に達しました。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | アカウントの毎分の連携上限に達しています。retryAfterSeconds を確認してください。 |
| 500 | INTERNAL_ERROR | 保存済みの完成したJSONを読み取り、または検証できませんでした。 |
| 503 | INTERNAL_ERROR | pending の保存済み結果はまだ取得できません。再生成する前に同じ結果を確認してください。 |
| 503 | SERVER_RESTARTING | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["transcription:read"]
}
}
このページは役に立ちましたか？