curl --request POST 'https://api.voicecheap.ai/v1/actions/tools_upload_import' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"url":"https://media.example.com/interview.mp4","filename":"interview.mp4","kind":"transcription","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
url: 'https://media.example.com/interview.mp4',
filename: 'interview.mp4',
kind: 'transcription',
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tools_upload_import', {
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/tools_upload_import",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"url": "https://media.example.com/interview.mp4", "filename": "interview.mp4", "kind": "transcription", "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": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
"fileName": "interview.mp4",
"fileSize": 1048576,
"durationSeconds": 60,
"mimeType": "video/mp4",
"uploadType": "video",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "tools_upload_import",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "tools_upload_import",
"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"
}
文字起こし
URL からメディアをインポート(文字起こし)
直接アクセスできる公開 HTTPS 音声・動画 URL をアカウントにインポートします。リダイレクトとプライベートネットワークは拒否され、ファイルと長さの制限が適用されます。生成アクションでは、返された fileKey を使用してください。
POST
/
v1
/
actions
/
tools_upload_import
curl --request POST 'https://api.voicecheap.ai/v1/actions/tools_upload_import' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"url":"https://media.example.com/interview.mp4","filename":"interview.mp4","kind":"transcription","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
url: 'https://media.example.com/interview.mp4',
filename: 'interview.mp4',
kind: 'transcription',
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tools_upload_import', {
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/tools_upload_import",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"url": "https://media.example.com/interview.mp4", "filename": "interview.mp4", "kind": "transcription", "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": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
"fileName": "interview.mp4",
"fileSize": 1048576,
"durationSeconds": 60,
"mimeType": "video/mp4",
"uploadType": "video",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "tools_upload_import",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "tools_upload_import",
"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"
}
直接アクセスできる公開 HTTPS 音声・動画 URL をアカウントにインポートします。リダイレクトとプライベートネットワークは拒否され、ファイルと長さの制限が適用されます。生成アクションでは、返された fileKey を使用してください。
必要な権限:
POST https://api.voicecheap.ai/v1/actions/tools_upload_import
認証と権限
string
必須
このヘッダーに VoiceCheap API キーを指定してください。同じ API キーを Authorization: Bearer で送信することもできます。OAuth アクセストークンは MCP
でのみ使用でき、この REST エンドポイントでは使用できません。
transcription:write.
有効な有料サブスクリプションが必要です。権限によってチーム内のロール、リソースの所有権、メディアクレジット、プランの制限が変わることはありません。
パラメーター
string
必須
テキスト値。最大文字数: 4096. 形式: “uri”.
string
テキスト値。最小文字数: 1. 最大文字数: 255. パターン:
^[^/\\\r\n\0]+$.string
必須
テキスト値。許容値: “transcription”, “video_to_srt”, “add_subtitles”, “animated_captions”, “project”.
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": {
"url": {
"type": "string",
"maxLength": 4096,
"format": "uri"
},
"filename": {
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[^/\\\\\\r\\n\\0]+$"
},
"kind": {
"type": "string",
"enum": ["transcription", "video_to_srt", "add_subtitles", "animated_captions", "project"]
},
"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": ["url", "kind"],
"additionalProperties": false
}
冪等性
変更操作ごとに、requestId または Idempotency-Key HTTP ヘッダーに UUID v4 を指定してください。ネットワーク障害後の再試行では、同じ識別子と同一の引数を使用します。両方を指定する場合は一致させる必要があります。保存済みリクエストを再取得しても、操作は再実行されず、月間呼び出し回数も追加で消費されません。失敗または中断したリクエストは自動的には再開されません。 すべての変更操作は、再試行時に同じリクエストがまだ実行中であれば、通常の初回実行が同期処理であっても HTTP 202 を返す場合があります。実行が完了していても resultStored が false の場合、再試行では元の結果ではなく、保存済みリクエストの状態を HTTP 200 で返します。出力は対応するドメインの履歴、結果、またはダウンロードアクションで取得してください。リクエスト例
例に記載されたリソース識別子とメディアキーを、ご自身のアカウントで返された値に置き換えてください。同じ変更操作を再試行する場合は、リクエスト識別子を変更しないでください。curl --request POST 'https://api.voicecheap.ai/v1/actions/tools_upload_import' \
--header "x-api-key: $VOICECHEAP_API_KEY" \
--header 'Content-Type: application/json' \
--data '{"url":"https://media.example.com/interview.mp4","filename":"interview.mp4","kind":"transcription","requestId":"13579bdf-2468-4ace-8bdf-0123456789ab"}'
const input = {
url: 'https://media.example.com/interview.mp4',
filename: 'interview.mp4',
kind: 'transcription',
requestId: '13579bdf-2468-4ace-8bdf-0123456789ab',
};
const response = await fetch('https://api.voicecheap.ai/v1/actions/tools_upload_import', {
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/tools_upload_import",
headers={"x-api-key": os.environ["VOICECHEAP_API_KEY"]},
json={"url": "https://media.example.com/interview.mp4", "filename": "interview.mp4", "kind": "transcription", "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)
レスポンス
この操作は実行中に HTTP 202 を返します。requestId を保存し、その識別子と元の操作名を指定して action_request_get をポーリングしてください。ポーリングの状態は running、completed、failed、interrupted です。完了した結果が別のメディアジョブを示す場合は、その操作に対応するステータスまたは出力取得アクションで処理を続けてください。 インポート済みの、実行者が所有するメディア参照。サイズ、長さ、メディアの種類、読み取りURLが検証済みです。これはポーリング後の、完了したアクションの出力です。{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"status": "running",
"pollAction": "action_request_get",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
"fileName": "interview.mp4",
"fileSize": 1048576,
"durationSeconds": 60,
"mimeType": "video/mp4",
"uploadType": "video",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "tools_upload_import",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"status": "running",
"pollAfterSeconds": 5
},
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab"
}
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "tools_upload_import",
"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.fileKey | 生成アクション用の、所有する完了済み参照。 |
data.fileName | 安全な形式に処理されたインポート済みファイル名。 |
data.fileSize | ダウンロードしたソースのバイト数。 |
data.durationSeconds | 解析で取得したソースの長さ(秒)。 |
data.mimeType | 対応するファイル拡張子から推定したメディアのMIMEタイプ。 |
data.uploadType | audio または video。 |
data.readUrl | インポートしたソースを読み取るための一時 URL。生成には fileKey を使用します。 |
リクエストの復旧とポーリング
接続が切断された後も同じ識別子を使用してください。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":"tools_upload_import"}'
HTTP 200
{
"data": {
"requestId": "13579bdf-2468-4ace-8bdf-0123456789ab",
"operation": "tools_upload_import",
"status": "completed",
"createdAt": 1792144800000,
"updatedAt": 1792144820000,
"resultStored": true,
"result": {
"fileKey": "uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4",
"fileName": "interview.mp4",
"fileSize": 1048576,
"durationSeconds": 60,
"mimeType": "video/mp4",
"uploadType": "video",
"readUrl": "https://media.example.com/uploads/account-user/a1b2c3d4-e5f6-4789-8abc-def012345678-interview.mp4"
}
}
}
操作の注意事項
- 有料サブスクリプションとアクションの権限が必要です。実行時に、実行者の個人向けツールプランが再確認されます。認証情報がチームに関連付けられていても、保存済みツールとアップロード参照はその実行者に属します。
- 成功したアクションは、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、引数を変えないでください。キャッシュからの再応答は、月間呼び出し枠を追加消費しません。
- アップロードのプレフィックスによって必要な権限が決まります。tools は transcription:write、subtitles は subtitles:write、projects は projects:write、voices は voices:write を使用します。
- ツール、字幕、プロジェクトでは、kind は transcription、video_to_srt、add_subtitles、animated_captions、project を受け付けます。選択した kind によってワークフローの上限が決まり、プレフィックスが kind を強制することはありません。
- 選択した kind ごとに上限が適用されます。transcription は 200 MiB、video_to_srt と add_subtitles は 300 MiB、animated_captions は 250 MiB で音声のみ、project はプランのアップロード上限(Beginner 5 GiB、Starter 10 GiB、Creator 20 GiB、Pro 30 GiB、Scale 40 GiB、Enterprise 60 GiB)を使用します。単体ツールのメディアは最大2時間です。字幕はBeginnerで30分、上位の公開プランで60分までで、コンテナには2秒の許容幅があります。プロジェクトの長さは最大2時間、Enterpriseでは3時間です。
- このアクションは非同期で実行されます。操作名と元の requestId を指定して、完了するまで action_request_get をポーリングしてから、結果の fileKey を取得してください。
- 公開 HTTPS 音声/動画ファイルへの直接 URL を使用してください。リダイレクト、認証情報、フラグメント、443 以外のポート、非公開の DNS アドレスは拒否されます。YouTube の視聴ページは直接メディア URL ではありません。専用の YouTube アクションを使用してください。
- URL パスの末尾が対応するメディアファイル名の場合、filename は任意です。保存時のファイル名はサニタイズされます。サーバーは fileKey を返す前に、実際の長さを解析します。
- インポートはメディアを準備し、月間連携呼び出しの成功回数を1回消費します。ツールの1日あたりの生成枠は、その後の生成時にのみ消費されます。
使用量
正常に実行された呼び出しごとに、月間 API/MCP 呼び出し回数を 1 回消費します。メディアクレジットと、その操作固有の生成枠も適用されます。エラー
| HTTP ステータス | コード | 意味または対処方法 |
|---|---|---|
| 400 | CREDENTIAL_IN_QUERY | access_token または api_key クエリパラメーターに認証情報が指定されています。認証情報はヘッダーで送信してください。 |
| 400 | EMPTY_MEDIA | 直接メディアURLが空の本文を返しました。 |
| 400 | FILE_TOO_LARGE | 申告された元ファイルまたはダウンロードした元ファイルが、選択した kind のアップロード上限を超えています。 |
| 400 | IDEMPOTENCY_CONFLICT | ヘッダーと本文のリクエスト ID が一致しません。 |
| 400 | INVALID_FILE_TYPE | 指定されたファイル名または URL から取得したファイル名に、選択した kind で対応する拡張子がありません。 |
| 400 | INVALID_MEDIA_DURATION | ダウンロードしたメディアの長さを解析できないか、選択した kind のプラン上限を超えています。 |
| 400 | INVALID_MEDIA_TYPE | レスポンスのコンテンツタイプが audio、video、application/ogg、application/octet-stream のいずれでもありません。 |
| 400 | INVALID_MEDIA_URL | ユーザー認証情報、フラグメント、443以外のポートを含まない直接HTTPS URLを使用し、有効なメディアファイル名を指定してください。 |
| 400 | INVALID_REQUEST_ID | requestId または Idempotency-Key が UUID v4 ではありません。 |
| 400 | MEDIA_DOWNLOAD_REFUSED | 直接ダウンロードが HTTP 200 を返しませんでした。リダイレクトは拒否されます。 |
| 400 | MEDIA_IMPORT_FAILED | ソースのダウンロード、解析、または保存ができませんでした。公開 URL とメディア形式を確認してください。 |
| 400 | MEDIA_URL_NOT_PUBLIC | ホスト名を解決できないか、解決されたアドレスの少なくとも1つがプライベート、またはその他の非公開アドレスです。 |
| 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 | INSUFFICIENT_SCOPE | APIキーまたはMCP接続に、必要なアクション権限がありません。 |
| 403 | INTEGRATION_PLAN_UNSUPPORTED | アカウントの連携上限を確認できませんでした。 |
| 403 | PAID_SUBSCRIPTION_REQUIRED | このツールアクションの実行時点で、認証済み実行者の有料サブスクリプションが有効ではありません。 |
| 403 | SUBSCRIPTION_REQUIRED | 有効な有料サブスクリプションを使用してください。 |
| 403 | TEAM_OWNER_NOT_FOUND | 実効的なチームオーナーのアカウントが見つかりませんでした。 |
| 409 | CONCURRENT_ACTION_LIMIT_REACHED | このアカウントでは、すでに 10 件の連携アクションが実行中です。新しいアクションを開始する前に、既存のリクエストをポーリングしてください。 |
| 409 | IDEMPOTENCY_CONFLICT | 識別子を再利用する場合は、同じ操作と引数でのみ使用してください。 |
| 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": ["transcription:write"]
}
}
このページは役に立ちましたか?

