curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_burn_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001"}'
const input = {
historyId: 'history_20261016_001',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_burn_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/subtitles_burn_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"historyId": "history_20261016_001",
"fileName": "interview.mp4",
"downloadUrl": "https://media.example.com/outputs/subtitled-interview.mp4"
}
}
字幕とキャプション
字幕付き動画をダウンロード
保存済みの字幕付き動画 1 件の一時的なダウンロード URL を取得します。
POST
/
v1
/
actions
/
subtitles_burn_download
curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_burn_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001"}'
const input = {
historyId: 'history_20261016_001',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_burn_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/subtitles_burn_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"historyId": "history_20261016_001",
"fileName": "interview.mp4",
"downloadUrl": "https://media.example.com/outputs/subtitled-interview.mp4"
}
}
保存済みの字幕付き動画 1 件の一時的なダウンロード URL を取得します。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/subtitles_burn_download
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
subtitles:read.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
string
必須
テキスト値。最小文字数: 1. 最大文字数: 160. パターン:
^[A-Za-z0-9_-]+$.完全な入力スキーマ
完全な入力スキーマ
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
{
"type": "object",
"properties": {
"historyId": {
"type": "string",
"minLength": 1,
"maxLength": 160,
"pattern": "^[A-Za-z0-9_-]+$"
}
},
"required": ["historyId"],
"additionalProperties": false
}
リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_burn_download' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001"}'
const input = {
historyId: 'history_20261016_001',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_burn_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/subtitles_burn_download",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 レンダリング済みの実行者所有の字幕付き動画に対する、更新された一時ダウンロード URL。{
"data": {
"historyId": "history_20261016_001",
"fileName": "interview.mp4",
"downloadUrl": "https://media.example.com/outputs/subtitled-interview.mp4"
}
}
結果フィールド
| フィールド | 説明 |
|---|---|
data.historyId | 選択した、所有する字幕焼き込み履歴の ID。 |
data.fileName | 履歴に保存された元のソースファイル名。 |
data.downloadUrl | レンダリング済み動画の一時メディア URL。非公開のアクセス情報として扱ってください。 |
操作の注意事項
- 有料サブスクリプションとアクションの権限が必要です。実行時に、実行者の個人向けツールプランが再確認されます。認証情報がチームに関連付けられていても、保存済みツールとアップロード参照はその実行者に属します。
- 成功したアクションは、API/MCP 共通の月間呼び出し枠を1回消費します。月間上限は Beginner が 500 回、Starter が 5,000 回、Creator が 25,000 回で、Pro、Scale、Enterprise に月間上限はありません。毎分の上限はそれぞれ 30、60、120、180、300、600 回で、引き続き適用されます。ツールの生成枠は別です。
- historyId は、アップロードまたはYouTubeソースの保存済み字幕追加履歴を選択します。ハンドラーは、動画URLの発行前に所有権を確認します。
- 返される fileName は元のソース履歴のファイル名で、実際にレンダリングされた MP4 の拡張子を示すとは限りません。downloadUrl はレンダリング済み動画を指します。
- 既存の出力を取得します。再レンダリングは行わず、アップロード枠や1日あたりのレンダリング枠も消費しません。
使用量
正常に実行された呼び出しごとに、月間 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 | ADD_SUBTITLES_HISTORY_NOT_FOUND | この実行者のレンダリング済み字幕履歴項目は存在しません。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 使用済みと処理待ちの呼び出し数が、共有の月間 API/MCP 利用枠に達しました。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | アカウントの毎分の連携上限に達しています。retryAfterSeconds を確認してください。 |
| 500 | INTERNAL_ERROR | 保存済みの出力動画 URL を読み取れませんでした。 |
| 503 | SERVER_RESTARTING | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["subtitles:read"]
}
}
このページは役に立ちましたか?

