curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_history_update' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001","currentSrtContent":"1\n00:00:00,000 --> 00:00:01,500\nHello world.\n","expectedRevision":1,"layoutOptions":{"maxLinesPerCaption":2,"maxCharactersPerLine":42},"styleOptions":{"fontFamily":"sans","fontSize":"medium","textColor":"white","backgroundStyle":"outline","position":"bottom"},"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
historyId: 'history_20261016_001',
currentSrtContent: '1\n00:00:00,000 --> 00:00:01,500\nHello world.\n',
expectedRevision: 1,
layoutOptions: {
maxLinesPerCaption: 2,
maxCharactersPerLine: 42,
},
styleOptions: {
fontFamily: 'sans',
fontSize: 'medium',
textColor: 'white',
backgroundStyle: 'outline',
position: 'bottom',
},
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_history_update', {
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_history_update",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001", "currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n", "expectedRevision": 1, "layoutOptions": {"maxLinesPerCaption": 2, "maxCharactersPerLine": 42}, "styleOptions": {"fontFamily": "sans", "fontSize": "medium", "textColor": "white", "backgroundStyle": "outline", "position": "bottom"}, "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)
{
"data": {
"historyId": "history_20261016_001",
"revision": 2,
"updatedAt": 1792152010000,
"currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"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"
}
字幕とキャプション
保存済み字幕を編集
最新のリビジョンを指定して、保存済みの SRT とレイアウトを更新します。同時編集で互いに上書きしないよう、古いリビジョンは拒否されます。
POST
/
v1
/
actions
/
subtitles_history_update
curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_history_update' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001","currentSrtContent":"1\n00:00:00,000 --> 00:00:01,500\nHello world.\n","expectedRevision":1,"layoutOptions":{"maxLinesPerCaption":2,"maxCharactersPerLine":42},"styleOptions":{"fontFamily":"sans","fontSize":"medium","textColor":"white","backgroundStyle":"outline","position":"bottom"},"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
historyId: 'history_20261016_001',
currentSrtContent: '1\n00:00:00,000 --> 00:00:01,500\nHello world.\n',
expectedRevision: 1,
layoutOptions: {
maxLinesPerCaption: 2,
maxCharactersPerLine: 42,
},
styleOptions: {
fontFamily: 'sans',
fontSize: 'medium',
textColor: 'white',
backgroundStyle: 'outline',
position: 'bottom',
},
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_history_update', {
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_history_update",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001", "currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n", "expectedRevision": 1, "layoutOptions": {"maxLinesPerCaption": 2, "maxCharactersPerLine": 42}, "styleOptions": {"fontFamily": "sans", "fontSize": "medium", "textColor": "white", "backgroundStyle": "outline", "position": "bottom"}, "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)
{
"data": {
"historyId": "history_20261016_001",
"revision": 2,
"updatedAt": 1792152010000,
"currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"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"
}
最新のリビジョンを指定して、保存済みの SRT とレイアウトを更新します。同時編集で互いに上書きしないよう、古いリビジョンは拒否されます。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/subtitles_history_update
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
subtitles:write.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
string
必須
テキスト値。最小文字数: 1. 最大文字数: 160. パターン:
^[A-Za-z0-9_-]+$.string
必須
テキスト値。最小文字数: 1. 最大文字数: 2097152.
integer
必須
整数値。最大値: 9007199254740991.
object
JSON オブジェクト。ネストされたフィールドは完全な入力スキーマを参照してください。
object
JSON オブジェクト。ネストされたフィールドは完全な入力スキーマを参照してください。
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}$.完全な入力スキーマ
完全な入力スキーマ
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
{
"type": "object",
"properties": {
"historyId": {
"type": "string",
"minLength": 1,
"maxLength": 160,
"pattern": "^[A-Za-z0-9_-]+$"
},
"currentSrtContent": {
"type": "string",
"minLength": 1,
"maxLength": 2097152
},
"expectedRevision": {
"type": "integer",
"exclusiveMinimum": 0,
"maximum": 9007199254740991
},
"layoutOptions": {
"type": "object",
"properties": {
"maxLinesPerCaption": {
"anyOf": [
{
"type": "number",
"const": 1
},
{
"type": "number",
"const": 2
},
{
"type": "number",
"const": 3
}
]
},
"maxCharactersPerLine": {
"type": "integer",
"minimum": 24,
"maximum": 64
}
},
"required": ["maxLinesPerCaption", "maxCharactersPerLine"],
"additionalProperties": false
},
"styleOptions": {
"type": "object",
"properties": {
"fontFamily": {
"type": "string",
"enum": ["sans", "serif", "mono"]
},
"fontSize": {
"type": "string",
"enum": ["small", "medium", "large"]
},
"textColor": {
"type": "string",
"enum": ["white", "yellow", "cyan"]
},
"backgroundStyle": {
"type": "string",
"enum": ["outline", "box", "shadow"]
},
"position": {
"type": "string",
"enum": ["bottom", "middle"]
}
},
"required": ["fontFamily", "fontSize", "textColor", "backgroundStyle", "position"],
"additionalProperties": false
},
"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": ["historyId", "currentSrtContent", "expectedRevision"],
"additionalProperties": false
}
冪等性
変更操作ごとに、requestId または Idempotency-Key HTTP ヘッダーに UUID v4 を指定してください。ネットワーク障害後の再試行では、同じ識別子と同一の引数を使用します。両方を指定する場合は一致させる必要があります。保存済みリクエストを再取得しても、操作は再実行されず、月間呼び出し回数も追加で消費されません。失敗または中断したリクエストは自動的には再開されません。 すべての変更操作は、再試行時に同じリクエストがまだ実行中であれば、通常の初回実行が同期処理であっても HTTP 202 を返す場合があります。実行が完了していても resultStored が false の場合、再試行では元の結果ではなく、保存済みリクエストの状態を HTTP 200 で返します。出力は対応するドメインの履歴、結果、またはダウンロードアクションで取得してください。リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。curl --request POST 'https://api.voicecheap.ai/v1/actions/subtitles_history_update' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"historyId":"history_20261016_001","currentSrtContent":"1\n00:00:00,000 --> 00:00:01,500\nHello world.\n","expectedRevision":1,"layoutOptions":{"maxLinesPerCaption":2,"maxCharactersPerLine":42},"styleOptions":{"fontFamily":"sans","fontSize":"medium","textColor":"white","backgroundStyle":"outline","position":"bottom"},"requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
historyId: 'history_20261016_001',
currentSrtContent: '1\n00:00:00,000 --> 00:00:01,500\nHello world.\n',
expectedRevision: 1,
layoutOptions: {
maxLinesPerCaption: 2,
maxCharactersPerLine: 42,
},
styleOptions: {
fontFamily: 'sans',
fontSize: 'medium',
textColor: 'white',
backgroundStyle: 'outline',
position: 'bottom',
},
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/subtitles_history_update', {
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_history_update",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"historyId": "history_20261016_001", "currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n", "expectedRevision": 1, "layoutOptions": {"maxLinesPerCaption": 2, "maxCharactersPerLine": 42}, "styleOptions": {"fontFamily": "sans", "fontSize": "medium", "textColor": "white", "backgroundStyle": "outline", "position": "bottom"}, "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)
レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 同じ編集可能な字幕履歴 ID と、増加した revision、更新タイムスタンプ、正規化された現在の SRT。{
"data": {
"historyId": "history_20261016_001",
"revision": 2,
"updatedAt": 1792152010000,
"currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"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"
}
結果フィールド
| フィールド | 説明 |
|---|---|
data.historyId | 既存の保存済み字幕項目。 |
data.revision | 前のリビジョンに1を加えた値。 |
data.updatedAt | 更新時刻。ミリ秒単位の Unix タイムスタンプ。 |
data.currentSrtContent | 検証、並べ替え、正規化済みの保存された SRT テキスト。 |
リクエストの復旧とポーリング
接続が切断された後も同じ識別子を使用してください。resultStored が false の場合は、対応する履歴、結果、またはダウンロードアクションで出力を取得します。進捗を確認するためだけに、別の生成を開始しないでください。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":"subtitles_history_update"}'
HTTP 200
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "subtitles_history_update",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"historyId": "history_20261016_001",
"revision": 2,
"updatedAt": 1792152010000,
"currentSrtContent": "1\n00:00:00,000 --> 00:00:01,500\nHello world.\n"
}
}
}
操作の注意事項
- 有料サブスクリプションとアクションの権限が必要です。実行時に、実行者の個人向けツールプランが再確認されます。認証情報がチームに関連付けられていても、保存済みツールとアップロード参照はその実行者に属します。
- 成功したアクションは、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、引数を変えないでください。キャッシュからの再応答は、月間呼び出し枠を追加消費しません。
- 最初に subtitles_history_get を読み取り、その revision を expectedRevision として渡してください。古いリビジョンでは VIDEO_TO_SRT_HISTORY_CONFLICT が返され、別の編集を上書きできません。
- SRT の字幕キューは解析、並べ替え、正規化されます。重複することや、ソースメディアの長さに 0.5 秒を加えた範囲を超えることはできません。入力の上限は UTF-8 SRT の 2 MiB です。
- layoutOptions と styleOptions を省略すると、以前のカスタム値は暗黙に保持されず、標準のデフォルト値(2行、42文字、sans/medium/white/outline/bottom)に正規化されます。カスタム書式を保持する場合は両方を指定してください。
- 保存済み SRT 履歴のテキストと書式を編集します。新しい動画のレンダリング、再文字起こし、アップロード済みメディアの消費、1日あたりの生成枠の追加消費は行いません。
使用量
正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。エラー
| HTTP ステータス | コード | 意味または対処方法 |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | access_token または api_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | IDEMPOTENCY_CONFLICT | ヘッダーと本文のリクエスト ID が一致しません。 |
| 400 | INVALID_REQUEST_ID | requestId または Idempotency-Key が UUID v4 ではありません。 |
| 400 | VALIDATION_ERROR | 引数がアクションのスキーマを満たしていないか、不明な引数が指定されています。 |
| 400 | VIDEO_TO_SRT_HISTORY_INVALID_SRT | SRT 字幕キューのテキストまたはタイムスタンプ構造が不正です。 |
| 400 | VIDEO_TO_SRT_HISTORY_OUTSIDE_MEDIA | キューの終了時刻が、記録済みの元メディアの長さに許容値 0.5 秒を加えた時刻を超えています。 |
| 400 | VIDEO_TO_SRT_HISTORY_OVERLAP | 少なくとも 2 つの字幕キューが重複しています。 |
| 400 | VIDEO_TO_SRT_HISTORY_SRT_TOO_LARGE | 編集後の SRT が、UTF-8 で 2 MiB の上限を超えています。 |
| 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 | PAID_SUBSCRIPTION_REQUIRED | このツールアクションの実行時点で、認証済み実行者の有料サブスクリプションが有効ではありません。 |
| 403 | SUBSCRIPTION_REQUIRED | 有効な有料サブスクリプションを使用してください。 |
| 403 | TEAM_OWNER_NOT_FOUND | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | VIDEO_TO_SRT_HISTORY_NOT_FOUND | 実行者が所有する、編集可能な字幕履歴の項目が存在しません。 |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | このアカウントでは、すでに 10 件の連携アクションが実行中です。新しいアクションを開始する前に、既存のリクエストをポーリングしてください。 |
| 409 | IDEMPOTENCY_CONFLICT | 識別子を再利用する場合は、同じ操作と引数でのみ使用してください。 |
| 409 | VIDEO_TO_SRT_HISTORY_CONFLICT | expectedRevision が古くなっています。subtitles_history_get を再度読み取り、現在の revision を使用して編集を再試行してください。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 使用済みと処理待ちの呼び出し数が、共有の月間 API/MCP 利用枠に達しました。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | アカウントの毎分の連携上限に達しています。retryAfterSeconds を確認してください。 |
| 500 | INTERNAL_ERROR | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | ACTION_RESULT_UNAVAILABLE | アクションは実行されましたが、リクエスト結果の永続保存を確認できませんでした。別の書き込みを開始する前に、同じアクションと requestId をポーリングし、リソースの履歴を確認してください。 |
| 503 | SERVER_RESTARTING | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["subtitles:write"]
}
}
このページは役に立ちましたか?

