ドキュメントを探す
API リファレンス
YouTube Download API
YouTubeビデオまたはオーディオをクラウドストレージにダウンロードします。 解像度、フォーマット、クリップの所要時間を選択し、完了して非同期ジョブを追跡します。
YouTube 動画ダウンロード API — Python サンプル
リクエストを作成
URL 全体ではなく、動画 URL に含まれる 11 文字の ID。
高度なメディアオプション
フォーマットセレクターは品質、フレームレート、音声言語選択を上書きします。 出力形式とクリップ境界は依然に適用されます。 クリップエンドは、開始に従う必要があります。 境界は省略できます。
保管先
Blank は UTC のアップロード日 (YYYMMDD) を使用します。
コードを実行する前に、サーバーにストレージの認証情報を追加します。 ファイルをアップロードする許可が必要です。
プロバイダの資格情報とストレージの要件完成したwebhook
Webhookペイロード、検証、および復元Markdownは、完成した結果に適用されます。 受取人や就業状況は、元のフィールドを保持します。
https://data.flashdata.dev/v1/queriesパラメーター
送信 source とりあえず video_id 最上位レベル。 ソースのオプションは、 params. オプションのフィールドは省略可能です。
リクエストボディ
sourcestring / 必須- youtube_downloadに設定します。
video_idstring / 必須- 11-character YouTubeビデオID、FUfGcZ092b0などの。 手紙、数字、アンダースコア、ハイフンを受け入れる。正確に 11 キャラクターデフォルト:
設定なし受け入れられたフォーマット
^[A-Za-z0-9_-]{11}$ paramsobject / 必須- この要求のためのSettings。
callback_urlstring · nullable / 任意- Asyncとバッチだけ。 パブリック HTTPS エントリーフォーム URL 港に 443まで、 2,048 文字。 ユーザーの資格情報や URL フラグメントはありません。 Omit は、通知なしの null または空の文字列を使用します。 バッチでは、各クエリで、外部のパラメータで設定します。デフォルト:
設定なし
ビデオ&オーディオ
params.download_typestring / 任意- audio_videoはビデオとオーディオをマージします。ビデオはビデオのみを選択します。オーディオは音声のみを選択します。1 へ へ へ へ 11 キャラクター値:
audio_video / video / audioデフォルト:"audio_video" params.video_qualitystring / 任意- ビデオ解像度の選択。 音声のみダウンロード用Omit1 へ へ へ へ 40 キャラクター値:
best / worst / <=144 / ==144 / >=144 / <=360 / ==360 / >=360 / <=480 / ==480 / >=480 / <=720 / ==720 / >=720 / <=1080 / ==1080 / >=1080 / <=1440 / ==1440 / >=1440 / <=2160 / ==2160 / >=2160 / <=4320 / ==4320 / >=4320デフォルト:"<=720" params.fpsstring / 任意- フレームレート制約: >=、<=、=== は、1 から 240 に値が続く。 音声のみダウンロード用Omit1 へ へ へ へ 6 キャラクターデフォルト:
設定なし受け入れられたフォーマット
^(?:>=|<=|==)(?:[1-9]\d?|1\d\d|2[0-3]\d|240)$ params.audio_languagestring / 任意- 可聴周波トラックの選択。 audio_video とオーディオに適用されます。1 へ へ へ へ 8 キャラクター値:
default / originalデフォルト:"default" params.audio_qualitystring / 任意- kbps の可聴周波だけビットレート、またはベスト。 数値選択は文字列として送信する必要があります。 ビデオのダウンロードのためのOmit.1 へ へ へ へ 10 キャラクター値:
best / 320 / 256 / 192 / 128デフォルト:"best" params.output_formatstring / 任意- ビデオ:mp4、webmまたはmkv。 可聴周波:m4a、mp3またはオプス。1 へ へ へ へ 10 キャラクター値:
mp4 / webm / mkv / m4a / mp3 / opusデフォルト:mp4 (video) / m4a (audio) params.yt_dlp_formatstring / 任意- 1 から 1,024 文字までの高度なフォーマットセレクター。 制御文字は拒否されます。 値を無視するvideo_quality、fps、audio_languageをオーバーライドします。 出力形式とクリップはまだ適用されます。1 へ へ へ へ 1,024 キャラクターデフォルト:
設定なし params.upload_metadataboolean / 任意- ストレージのメディアファイルと一緒にメタデータJSONファイルをアップロードします。
trueまたはfalseデフォルト:false
クリップ
params.start_atstring / 任意- クリップはH:MM:SSかH:MM:SSのフォーマット、00:00:00からの12:00:00に始まります。 end_atのみが供給されると、00:00:00にデフォルト値を設定します。1 へ へ へ へ 8 キャラクターデフォルト:
設定なし受け入れられたフォーマット
^\d{1,2}:[0-5]\d:[0-5]\d$ params.end_atstring / 任意- H:MM:SS または HH:MM:SS 形式のクリップエンド、12:00:00 まで。 start_atよりも後続する必要があります。1 へ へ へ へ 8 キャラクターデフォルト:
設定なし受け入れられたフォーマット
^\d{1,2}:[0-5]\d:[0-5]\d$
保管先
params.storageobject / 必須- 完成したメディアファイルの宛先。 リストされた記憶分野だけを受け入れます。
params.storage.storage_typestring / 必須- ストレージプロバイダ: s3, s3_compatible, oss, gcs, azure, cos, bos または tos.
params.storage.storage_urlstring / 必須- 1,024文字までの非空バケットまたはコンテナ名。 空白を外します。 s3 では、URL やフォルダーパスなしで有効な AWS の Bucket 名を使用します。フォルダーは object_prefix にあります。
params.storage.object_prefixstring / 任意- Object-key 接頭辞、1 から 512 文字。 それぞれのスラッシュ区切りセグメントは、ASCII文字、数字、ドット、アンダースコア、ハイフン、空のセグメント、および . が拒否されます。 急激なスラッシュはありません。 空白とスラッシュの1つを囲む。 YYYMMDDは、archive/YYYYMMDD.に含まれるUTCのアップロード日を使用します。デフォルト:
"YYYYMMDD" params.storage.access_keystring / 任意- S3、S3互換、OSS、COS、BOS、TOS、secret_keyと組み合わせたアクセスキー。
params.storage.secret_keystring / 任意- S3、S3互換、OSS、COS、BOS、TOSの秘密鍵。
params.storage.endpoint_urlstring / 任意- S3互換ストレージまたはOSS用のパブリックHTTPSエンドポイント。 COS、BOS、TOSは地域から導き出します。
params.storage.regionstring / 任意- COS、BOS、TOS、S3、S3互換ダウンロードも対応可能です。 COS バケット名には、APPID が含まれます。
params.storage.service_accountobject / 任意- GCSサービスアカウント:project_id、client_email、PEM private_key。
params.storage.account_namestring / 任意- Azureストレージアカウント名。 storage_urlのコンテナ名を使用します。
params.storage.sas_tokenstring / 任意- 書き込み可能 Azure コンテナ SAS と expiry とシグネチャ。
レスポンス
Async または Batch でダウンロードを提出し、必要 params.storage. HTTPの特長 200 とりあえず status: pending 受諾、配達確認無し。 Batchは、ビデオIDごとの1つのジョブレシートを返します。
参加申し込み usage.credits は、 0. ダウンロードは、配信後に配信されたメディアのボリュームによって請求されます。オプションのメタデータは、ダウンロード料金に追加しません。
ポイル job.status までの流れ completed, それから結果JSONを取除きます。 媒体の細部をで読む results[0], アップロードされたオブジェクトを含む file_url, ファイルサイズとチェックサム.
結果を読む
ジョブが完了したら、response.json として結果リンクから JSON を保存します。 これをread-response.pyとして保存し、python read-response.pyを実行します。 メディアをダウンロードしたり、別のリクエストをしたりすることなく、ファイルの詳細を読みます。
import json
from pathlib import Path
response = json.loads(Path("response.json").read_text(encoding="utf-8-sig"))
if response.get("status") not in ("done", "completed") or not isinstance(response.get("results"), list):
raise SystemExit("Expected completed result JSON; inspect the response or job status.")
if not response["results"]:
print("[]")
raise SystemExit(0)
result = response["results"][0]
output = {name: result.get(name) for name in (
"file_url", "file_size", "md5", "duration", "output_format"
)}
# Use your storage credentials to access the media at file_url.
print(json.dumps(output, ensure_ascii=False, indent=2))ステータスには、メディアの詳細情報が含まれる場合があります。 job.result. デフォルト JSON ワークフローは、利用可能なときに使用し、それ以外の場合はフォローします。 rel: results リンク; インライン結果が常に存在すると仮定しません。
すべての投稿応答フィールド
| フィールド | 説明: |
|---|---|
idstring | ID をダウンロードします。 |
sourcestring | youtube_download.の特長 |
statusstring | 求人受付時に終了します。 |
created_atstring | ISO 8601 形式のジョブ作成時間。 |
usage.creditsnumber | 0 を投稿します。 ダウンロードは、完了後、データ量を配信していただきます。 |
linksarray | ジョブの状態と完了した出力の結果リンクのセルフリンクに従ってください。 |
links[].relstring | 自己または結果。 |
links[].hrefstring | URL は同じ API キーと照会するためです。 |
links[].methodstring | GET.の特長 |
完全なメディアファイルフィールド
| フィールド | 説明: |
|---|---|
results[0].file_urlstring | 保存中のメディアファイルの場所。 |
results[0].file_sizeinteger | バイト内のメディアファイルサイズ。 |
results[0].downloaded_bytesinteger | 請求に使用されるメディアバイトを配信しました。 |
results[0].md5string | メディアファイルのMD5チェックサム。 |
results[0].resolutionstring · nullable | 音声のみの出力または使用不能の高さのためのビデオ解像度、またはnull。 |
results[0].durationnumber · nullable | 秒単位で使用可能。 |
results[0].output_formatstring | 出力ファイル形式。 |
results[0].fpsnumber · nullable | 利用できる場合フレーム率。 |
results[0].video_codecstring · nullable | 利用可能なビデオコーデック。 |
results[0].audio_codecstring · nullable | 利用可能なオーディオコーデック。 |
results[0].dynamic_rangestring · nullable | 利用できる場合のビデオ動的範囲。 |
results[0].metadataobject · optional | upload_metadata が true であるとき、メタデータ file_url、file_size および md5 です。 メタデータバイトは、ダウンロード料金から除外されます。 |
上記のフィールドは、デフォルトの JSON 応答を記述します。 フォーマットオプションは、メディアファイルではなく、配信レコードに適用されます。 JSON, テキストとMarkdownフォーマット.
Async及びバッチ ライフサイクル
提出は、結果ではなく、領収書を返します。 Async は 1 つのジョブを作成します。 バッチは別のジョブを返します。 queries[] あらゆる問い合わせに対応。 各ジョブを独立して追跡し、取得します。
提出する data.flashdata.dev; ジョブの状態と結果を読みます api.flashdata.dev 同じ X-API-Key を使って。 リンクしたAPIの基本例では、PythonとcURLを使用しています。
1. ジョブを保存 IDs
Asyncで一括ダウンロードするか、Batchクエリ配列内の複数のダウンロードリクエストをセットしてください。 各エントリーはparams.storageが必要です。 ID を返すジョブを全て保存します。
2. ステータスの確認
GET https://api.flashdata.dev/v2/jobs/{jobId}pending/processing: 遅延と敬意のある投票Retry-After現時点ではcompleted: 結果を取得します。failed: 検査job.error.job.status を読んでください。投稿レシートのステータスはありません。
ジョブステータス API 参照3. フェッチ結果
GET https://api.flashdata.dev/v2/jobs/{jobId}/results完了後、結果が読み込まれたことを認証し、取得します。 302 ストレージ URL あなたなしで API キー。 24 内の JSON を完成時間内に保存します。
JSONは、保存先のメディアを記述します。 メディアファイルへのアクセス.
フェッチ結果 · Python と cURL · レスポンス形式
結果は、APIリファレンスをダウンロード
既存の結果のポーリングとフェッチは、クエリクレジットを消費しません。 ポーリングのタイムアウトはジョブをキャンセルしません。重複した課金の作業を投稿する代わりに、IDをキープします。 エラーコードと再試行動作.
完了通知 Webhook
クエリごとに購読する
セットセット callback_url 非同期リクエストのトップレベル、または 各クエリの内部 バッチで、外側 params. 別途のwebhook-registrationリクエストが必要です。
公共利用 HTTPS URL 港に 443. FlashData POSTsは、各ジョブが到達する通知を送信します completed または failed; イベントは、結果自体ではなく、リンクが含まれています。
アクノレッジと検証
返品について 2xx イベントを厳しく受け入れた後。 重複排除 delivery_id, 、またとして送られます X-Delivery-Id. リダイレクトは続行しません。
緊急の配送再試行、最大 8 は合計を試みます そして最も 24 完了後時間. フォールバックとして花粉を保ちます。
コールバックは未署名です。 ジョブの ID、ソース、ターミナルの状態を経由して確認する 認証されたステータスエンドポイント 通知を処理する前に。 配達IDは信憑性の証拠ではなく、解読のためです。
Webhookイベントとフィールドの例
{
"delivery_id": "completion:job_example0001",
"id": "job_example0001",
"source": "youtube_download",
"status": "completed",
"links": [
{
"rel": "self",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001",
"method": "GET"
},
{
"rel": "results",
"href": "https://api.flashdata.dev/v2/jobs/job_example0001/results",
"method": "GET"
}
]
}| フィールド | 説明: |
|---|---|
delivery_idstring | 安定した配達識別子。 この値を使用して通知を複製します。また、X-Delivery-Id ヘッダーに送信されます。 |
idstring | 求人 ID. |
sourcestring | リクエストされたデータソース。 |
statusstring | 完了または失敗。 |
linksarray | ステータスと結果のリンク。 結果のコンテンツやAPIキーは、通知は含まれていません。 |
links[].relstring | 自己または結果。 |
links[].hrefstring | 絶対管理 API URL;あなたのAPIのキーと認証して下さい。 |
links[].methodstring | GET.の特長 |
Bulkファイル処理
1 行につき 1 つのビデオ ID をアップロードし、ソースで Bulk ジョブを作成します。: youtube_download. 共有オプションは、ファイル内のすべてのIDに適用されます。
必要な保存先を所定の場所に置く options.storage メディア設定 options. シングルジョブとBatchのダウンロードは、代わりにparams.storageを使用します。
クラウドストレージにメディアファイルが配信されます。 完了したBulkの結果には、マニフェストと結果の部分が含まれており、ダウンロードを記述します。 Bulkジョブ全体が完了した後、24時間以内にマニフェストと部品を保存します。
Bulk 加工プロセス API · Python とりあえず cURL · Batch JSON リクエスト
保管先
含まれるもの params.storage 各ダウンロードリクエストで。 セットセット storage_url バケットまたはコンテナ名に入力し、書き込みアクセスで認証情報を提供します。 ストレージの認証情報をサーバーに保存します。
{
"storage_type": "s3_compatible",
"storage_url": "your-media-bucket",
"object_prefix": "archive/YYYYMMDD",
"endpoint_url": "https://your-s3-endpoint.example.com",
"region": "your-provider-region",
"access_key": "<storage-access-key>",
"secret_key": "<storage-secret-key>"
}object_prefix デフォルトは YYYYMMDD, UTCのアップロード日付に置換します。 固定ディレクトリやテンプレートなどを使う archive/YYYYMMDD.
s3- access_keyとsecret_keyを書き込みアクセスで供給します。 Bucket の AWS 領域に地域を設定します。
s3 例)
{ "storage_type": "s3", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "us-east-1" } s3_compatibleの特長- access_key、secret_key、および公開HTTPS endpoint_urlを供給して下さい。 プロバイダーが要求する地域を設定します。 Cloudflare R2は自動を使用します。
s3_compatibleの特長 例)
{ "storage_type": "s3_compatible", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "endpoint_url": "https://YOUR_ACCOUNT_ID.r2.cloudflarestorage.com", "region": "auto" } azure- account_name と sas_token を、コンテナ SAS に書き込み権限 (sp には w が含まれています)、リソース sr=c、 expiry se、バージョン sv とシグネチャ sig を供給します。 storage_url はコンテナ名です。 endpoint_url、access_key、secret_keyを送らないで下さい。
azure 例)
{ "storage_type": "azure", "storage_url": "your-media-container", "account_name": "yourstorageaccount", "sas_token": "sv=2023-11-03&sr=c&sp=w&se=2099-01-01T00%3A00%3A00Z&sig=YOUR_SAS_SIGNATURE" } bos- access_key、secret_keyおよび地域:bj、suまたはhkg。 省略時は、地域からエンドポイントが誘導されます。 ドットなしの Bucket 名を使用してください。
bos 例)
{ "storage_type": "bos", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "bj" } cos- access_key、secret_keyおよびap-*領域を、ap-hongkongのような供給して下さい。storage_urlはAPPIDのサフィックスを含まなければなりません。 endpoint_urlを送らないでください。それは地域から派生しています。
cos 例)
{ "storage_type": "cos", "storage_url": "your-media-bucket-1234567890", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "ap-hongkong" } gcs- ソリューション service_account とりあえず project_id, client_email (a ) .gserviceaccount.com アドレス)、およびPEM private_key サービスアカウントから。 このアカウントは、 Bucket へのアクセスを記述する必要があります。 access_key、secret_key、地域またはendpoint_urlを送信しないでください。
gcs 例)
{ "storage_type": "gcs", "storage_url": "your-media-bucket", "service_account": { "project_id": "your-project-id", "client_email": "[email protected]", "private_key": "-----BEGIN PRIVATE KEY-----\nYOUR_PRIVATE_KEY\n-----END PRIVATE KEY-----\n" } } oss- access_key、secret_key、バケット領域の公開HTTPS endpoint_urlを供給します。
oss 例)
{ "storage_type": "oss", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "endpoint_url": "https://oss-cn-hongkong.aliyuncs.com" } tos- access_key、secret_keyおよび地域をcn、ap-、eu-またはus-接頭辞と供給して下さい。 省略時は、地域からエンドポイントが誘導されます。 ドットなしの Bucket 名を使用してください。
tos 例)
{ "storage_type": "tos", "storage_url": "your-media-bucket", "access_key": "YOUR_ACCESS_KEY", "secret_key": "YOUR_SECRET_KEY", "region": "cn-beijing" }
結果の file_url 保存中のオブジェクトを識別します。 プライベートオブジェクトは、ストレージプロバイダの承認または署名されたURLが必要です。 FlashData APIキーは、あなたのバケットへのアクセスを許可しません。
完全な投稿、ポーリング、ワークフローのダウンロードについては、 参照してください YouTubeオーディオをAmazon S3にダウンロード.
ファイルデリバリー
求人情報 rel: results endpoint のデフォルトはリダイレクトに 結果 JSON, MP4のダウンロードではなく、 FlashData は、実際のメディアを供給した Bucket やコンテナにアップロードします。 メディア保持は、あなたのバケットのポリシーに従います。ジョブの結果JSONは、完了後24時間を終了します。
results[0].file_url オブジェクトを識別しますが、自動的に公開または署名されていない URL. ストレージSDKでプライベートメディアにアクセスしたり、自社サーバーでURLに署名した短命の署名を生成したりできます。 FlashData APIキーをストレージプロバイダに送らないでください。
有効活用 upload_metadata アップロードする {video_id}_meta.json 同じ接頭辞の仲間。 その場所とチェックサムが下に表示されます results[0].metadata.
コンソールのブラウザのダウンロードモードは別です。 パブリックAPIは、あなた自身のストレージを使用しています。 コンソールのみが含まれていません browser_delivery 設定。
エラー回復
アップロード失敗やストレージのため 403, 、プロバイダー、バケット、地域、エンドポイント、オブジェクト書き込み権限を確認します。 到達不能または非公開 file_url アップロードが失敗したわけではありません。ストレージプロバイダからオブジェクトをチェックしてください。
削除または使用不能なビデオは、ポーリングによって回復することはできません。 未利用可能なフォーマットについては、検査 メタデータ形式, 、質の制約を緩めて下さいまたは高度のセレクターを取除いて下さい。 音声のみのリクエストは必須です m4a, mp3 または opus; ビデオ要求は要求します mp4, webm または mkv.
結果の JSON が期限切れとなった場合は、最初に配信されたメディアの Bucket をチェックします。 退会は、新しいダウンロードを作成し、別の充電を怠る可能性があります。 古い結果JSONを回復しません。
認証、残高、リクエスト形式、レート制限の失敗については、共有エラー参照を使用します。 提出期限は、まだジョブを作成している可能性があります。 再試行する前に、既存の作業を確認してください。
エラーとステータスコード · 再試行するとき · レート制限
ステップバイステップガイド: 1つのビデオをダウンロードし、配達を検証
料金
| プラン | 使用法率配達されるGBごとの | サブスクリプション | 請求期間ごとのクレジットを含む |
|---|---|---|---|
| 従量課金 | $0.10 | 月額料金なし | 必要に応じてチャージ |
| Micro | $0.08 | $49.00 / 月 月 日 | 1,000クレジット($50.00のAPI使用)付属 |
| Starter | $0.07 | $199.00 / 月 月 日 | 4,000クレジット($200.00のAPI使用)付属 |
| Pro | $0.06 | $499.00 / 月 月 日 | 10,000クレジット($500.00のAPI使用)付属 |
| Scale | $0.05 | $999.00 / 月 月 日 | 20,000クレジット($1,000.00のAPI使用)付属 |
| Business | $0.04 | $1,999.00 / 月 月 日 | 40,000クレジット($2,000.00のAPI使用)付属 |
アカウントごとに1つのプラン。3製品でクレジットを共有します。付属クレジットで支払った使用量に追加で課金されることはありません。
現在の価格とプランの制限