curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
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": 3,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "completed",
"createdAt": 1792152000000,
"startedAt": 1792152001000,
"finishedAt": 1792152002000
}
]
}
}
文字起こしと編集
セグメント操作の状態を取得
プロジェクトのセグメント編集または再生成操作について、待機中、実行中、完了の状態をポーリングします。
POST
/
v1
/
actions
/
segment_actions_list
curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
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": 3,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "completed",
"createdAt": 1792152000000,
"startedAt": 1792152001000,
"finishedAt": 1792152002000
}
]
}
}
プロジェクトのセグメント編集または再生成操作について、待機中、実行中、完了の状態をポーリングします。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/segment_actions_list
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
projects:read.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
string
必須
テキスト値。最小文字数: 1. 最大文字数: 200. パターン:
^[^/\\]+$.完全な入力スキーマ
完全な入力スキーマ
以下の JSON Schema は、ディスカバリーで公開される正確なフィールド名、ネストされた型、デフォルト値、範囲、許容値を保持しています。フィールド間の追加ルールは操作の注意事項に記載されています。
{
"type": "object",
"properties": {
"projectId": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"pattern": "^[^/\\\\]+$"
}
},
"required": ["projectId"],
"additionalProperties": false
}
リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。curl --request POST 'https://api.voicecheap.ai/v1/actions/segment_actions_list' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"projectId":"project_launch_2026"}'
const input = {
projectId: 'project_launch_2026',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/segment_actions_list', {
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_list",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"projectId": "project_launch_2026"},
timeout=120,
)
body = response.json()
if not response.ok:
raise RuntimeError(f"{body.get('code')}: {body.get('message')}")
print(body)
レスポンス
初回実行が成功すると、操作結果を data に格納して HTTP 200 を返します。同じリクエストを再送した場合は、代わりに保存済みリクエストの状態を返すことがあります。例はサポートされるレスポンスの一例であり、すべての任意フィールドを示すものではありません。 現在のプロジェクトキューのリビジョンと、queued、running、および終了状態のアクション項目の公開情報を返します。{
"data": {
"projectId": "project_launch_2026",
"revision": 3,
"items": [
{
"id": "41321bda-e243-4b6f-96a4-622cd047c991",
"action": {
"type": "text",
"segmentIndex": 0,
"source": "original"
},
"status": "completed",
"createdAt": 1792152000000,
"startedAt": 1792152001000,
"finishedAt": 1792152002000
}
]
}
}
結果フィールド
| フィールド | 説明 |
|---|---|
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 | 認証済みの閲覧者のみに対応する、任意の確認時刻。 |
操作の注意事項
- segments_text_update、segments_timestamps_update、segments_regenerate が返す jobId に一致する items[].id をポーリングしてください。completed、failed、cancelled は終了状態です。
- revision はキューのリビジョンです。削除や結合に必要な、原文の segmentStructureRevision ではありません。
- アクションは送信成功を返しても、その後キューで失敗する場合があります。items[].errorCode を確認し、新しいアクションを実行するか判断する前に、対象プロジェクト、文字起こし、出力の状態を再取得してください。
- この操作にはページネーションの入力はありません。キューがないプロジェクトでは、projectId、revision 0、空の items 配列を返します。
- 送信、キャンセル、ポーリング、再実行を含むキュー応答には、アクションのメタデータのみが含まれます。文字起こしの内容は、必要な transcription:read 権限で transcripts_get を使用して取得してください。
使用量
正常に実行された呼び出しごとに、月間 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 | FORBIDDEN | 認証済み実行者は、このプロジェクトにアクセスできません。 |
| 403 | INSUFFICIENT_SCOPE | 必要な権限をすべて付与するか、別の認証情報を使用してください。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | アカウントの連携上限を確認できませんでした。 |
| 403 | SUBSCRIPTION_REQUIRED | 有効な有料サブスクリプションを使用してください。 |
| 403 | TEAM_OWNER_NOT_FOUND | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 404 | PROJECT_NOT_FOUND | アクセス可能なアカウントにこのプロジェクトは存在しません。 |
| 429 | INTEGRATION_MONTHLY_LIMIT_REACHED | 月次リセットを待つか、プランを変更してください。 |
| 429 | INTEGRATION_RATE_LIMIT_REACHED | Retry-After がある場合は指定時間を待ち、バックオフを使用してください。 |
| 500 | INTERNAL_ERROR | 変更操作を再試行するか判断する前に、保存済みリクエストの状態とリソースの履歴を確認してください。 |
| 503 | SERVER_RESTARTING | サーバーが再起動中です。少し待ってから再試行し、変更操作では同じリクエスト識別子を使用してください。 |
{
"code": "INSUFFICIENT_SCOPE",
"message": "This credential does not permit the requested action.",
"status": 403,
"details": {
"requiredScopes": ["projects:read"]
}
}
このページは役に立ちましたか？