curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_cancel' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","jobId":"41321bda-e243-4b6f-96a4-622cd047c991","requestId":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}'
const input = {
projectId: 'project_launch_2026',
jobId: '41321bda-e243-4b6f-96a4-622cd047c991',
requestId: 'c6d1fec6-bf7d-40aa-91e7-e4b0676d6020',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_cancel', {
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/segment_actions_cancel",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "jobId": "41321bda-e243-4b6f-96a4-622cd047c991", "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"revision": 2,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "cancelled",
"createdAt": 1792152000000,
"finishedAt": 1792152002000
}
]
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
文字起こしと編集
待機中のセグメント操作をキャンセル
ご自身の待機中のセグメント操作をキャンセルします。すでに実行中の操作はキャンセルできません。
POST
/
v1
/
actions
/
segment_actions_cancel
curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_cancel' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","jobId":"41321bda-e243-4b6f-96a4-622cd047c991","requestId":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}'
const input = {
projectId: 'project_launch_2026',
jobId: '41321bda-e243-4b6f-96a4-622cd047c991',
requestId: 'c6d1fec6-bf7d-40aa-91e7-e4b0676d6020',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_cancel', {
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/segment_actions_cancel",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "jobId": "41321bda-e243-4b6f-96a4-622cd047c991", "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
{
"data": {
"projectId": "project_launch_2026",
"revision": 2,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "cancelled",
"createdAt": 1792152000000,
"finishedAt": 1792152002000
}
]
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
ご自身の待機中のセグメント操作をキャンセルします。すでに実行中の操作はキャンセルできません。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/segment_actions_cancel
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
translations:write.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
string
必須
テキスト値。最小文字数: 1. 最大文字数: 200. パターン:
^[^/\\]+$.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)$.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": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
},
"jobId": {
"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)$"
},
"requestId": {
"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}$",
"description": "UUID v4 for this action. Reuse the same ID with identical arguments on retries."
}
},
"required": ["projectId", "jobId"],
"additionalProperties": false
}
冪等性
変更操作ごとに、requestId または Idempotency-Key HTTP ヘッダーに UUID v4 を指定してください。ネットワーク障害後の再試行では、同じ識別子と同一の引数を使用します。両方を指定する場合は一致させる必要があります。保存済みリクエストを再取得しても、操作は再実行されず、月間呼び出し回数も追加で消費されません。失敗または中断したリクエストは自動的には再開されません。 すべての変更操作は、再試行時に同じリクエストがまだ実行中であれば、通常の初回実行が同期処理であっても HTTP 202 を返す場合があります。実行が完了していても resultStored が false の場合、再試行では元の結果ではなく、保存済みリクエストの状態を HTTP 200 で返します。出力は対応するドメインの履歴、結果、またはダウンロードアクションで取得してください。リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_cancel' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026","jobId":"41321bda-e243-4b6f-96a4-622cd047c991","requestId":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"}'
const input = {
projectId: 'project_launch_2026',
jobId: '41321bda-e243-4b6f-96a4-622cd047c991',
requestId: 'c6d1fec6-bf7d-40aa-91e7-e4b0676d6020',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_cancel', {
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/segment_actions_cancel",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026", "jobId": "41321bda-e243-4b6f-96a4-622cd047c991", "requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 キューで待機中のアクションをキャンセルし、更新後のキュー全体のスナップショットを返します。{
"data": {
"projectId": "project_launch_2026",
"revision": 2,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "cancelled",
"createdAt": 1792152000000,
"finishedAt": 1792152002000
}
]
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "completed",
"resultStored": false,
"message": "The action completed. Retrieve its output from the corresponding history or resource action."
},
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020"
}
結果フィールド
| フィールド | 説明 |
|---|---|
data.projectId | 親プロジェクトの識別子。 |
data.revision | キュースナップショットのリビジョン。projects_get.segmentStructureRevision とは独立しています。 |
data.items | プロジェクトのアクションの進行状況：ジョブ識別子、アクションのメタデータ、状態、タイムスタンプ、および任意の公開 errorCode。 |
data.items[].id | ジョブ識別子。元のキュー送信の requestId と一致します。 |
data.items[].action | アクションのメタデータのみ：type、segmentIndex、および任意の workId、translatedVersionId、source。送信されたテキスト、時間値、再生成の指示は返されません。 |
data.items[].status | queued、running、completed、failed、cancelled のいずれか。 |
data.items[].createdAt | キュー項目の作成時刻（Unixミリ秒）。 |
data.items[].startedAt | 省略可能な初回開始時刻。Unix 時間のミリ秒単位。 |
data.items[].finishedAt | 省略可能な終了時刻。Unix 時間のミリ秒単位。 |
data.items[].errorCode | 任意の公開エラーコード。分類されていない失敗には ACTION_FAILED を使用します。 |
data.items[].seenAt | 認証済みの閲覧者のみに対応する、任意の確認時刻。 |
リクエストの復旧とポーリング
接続が切断された後も同じ識別子を使用してください。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":"c6d1fec6-bf7d-40aa-91e7-e4b0676d6020","operation":"segment_actions_cancel"}'
HTTP 200
{
"data": {
"requestId": "c6d1fec6-bf7d-40aa-91e7-e4b0676d6020",
"operation": "segment_actions_cancel",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"projectId": "project_launch_2026",
"revision": 2,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "cancelled",
"createdAt": 1792152000000,
"finishedAt": 1792152002000
}
]
}
}
}
操作の注意事項
- jobId はキャンセル対象のキュー項目を識別します。requestId はキャンセルリクエスト用の、別の固定 UUID v4 です。
- cancelled にできるのは queued の項目だけです。running、completed、failed の項目はキャンセルできません。すでに cancelled の項目をキャンセルすると、現在のスナップショットを返します。
- ハンドラーは projectId、revision、items を直接返します。success の真偽値や、入れ子の queue フィールドはありません。
- キャンセルしても、完了済みの生成は返金されず、実行中のメディア処理も停止しません。
- 送信、キャンセル、ポーリング、再実行を含むキュー応答には、アクションのメタデータのみが含まれます。文字起こしの内容は、必要な transcription:read 権限で transcripts_get を使用して取得してください。
使用量
正常に実行された呼び出しごとに、月間 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 | スキーマに従って入力を修正してください。無効な値や整合性のない値は実行前に拒否されます。 |
| 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 | FORBIDDEN | 認証済み実行者は、このプロジェクトにアクセスできません。 |
| 403 | INSUFFICIENT_SCOPE | 必要な権限をすべて付与するか、別の認証情報を使用してください。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | アカウントの連携上限を確認できませんでした。 |
| 403 | SUBSCRIPTION_REQUIRED | 有効な有料サブスクリプションを使用してください。 |
| 403 | TEAM_OWNER_NOT_FOUND | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | NOT_FOUND | この jobId に対応するキュー項目はプロジェクト内に存在しません。 |
| 404 | PROJECT_NOT_FOUND | アクセス可能なアカウントにこのプロジェクトは存在しません。 |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | このアカウントでは、すでに 10 件の連携アクションが実行中です。新しいアクションを開始する前に、既存のリクエストをポーリングしてください。 |
| 409 | CONFLICT | キャンセルできるのは待機中のアクションだけです。この項目はすでに開始済み、または終了済みです。 |
| 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 | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["translations:write"]
}
}
このページは役に立ちましたか？