Skip to main content
POST
Trigger a media extraction job
媒体数据 API 默认未启用。请联系 support@brightdata.com 以在您的账户中启用该功能。
每个请求都需要一个交付目标。在发送第一个请求之前,请配置交付目标。请参阅 交付选项

输入字段

请求主体是一个 JSON 数组。数组中的每个对象都是一个单独的下载任务。
string
必填
要下载的视频的完整 URL。支持的平台:YouTube、Vimeo、TikTok、Bilibili。
string
默认值:"full"
指定要下载的内容类型。
boolean
默认值:"false"
是否下载视频的可用字幕或副标题。
string
默认值:"vtt"
下载字幕的文件格式。仅当 captionstrue 时适用。
integer
接受的最低视频分辨率,以垂直像素数表示。仅当存在等于或高于该高度的分辨率时,下载才会进行。常见值:360480720108014402160
integer
接受的最高视频分辨率,以垂直像素数表示。仅当存在等于或低于该高度的分辨率时,下载才会进行。常见值:360480720108014402160
boolean
默认值:"false"
是否在结果中包含视频的缩略图。
boolean
默认值:"false"
是否在结果中包含视频的故事板图像(用于时间线预览滚动的精灵图)。
string
用于文件上传的自定义路径。覆盖交付设置中配置的路径。支持模板变量:{{datetime}}{{video_id}}{{job}}示例: "my-videos/{{video_id}}/{{datetime}}"
string
已上传文件的自定义文件名。该值作为所有输出文件的基础名称使用(例如 <filename>.mp4<filename>.metadata.json<filename>.sub.0)。支持模板变量:{{datetime}}{{video_id}}{{job}}示例: "{{video_id}}_{{datetime}}"

授权

Authorization
string
header
必填

Your Bright Data API key. Find it in the Bright Data Control Panel.

查询参数

collector
string
必填

Your Media Extraction collector ID. This is a fixed value assigned when the feature is enabled on your account.

示例:

"YOUR_COLLECTOR_ID"

请求体

application/json

A JSON array of extraction job objects. Each object represents one media extraction job. Multiple jobs can be submitted in a single request.

Minimum array length: 1
url
string
必填

The full URL of the video to download. Supported platforms: YouTube, Vimeo, TikTok, Bilibili.

示例:

"https://www.video-page-example.com/v=89438398439"

format
enum<string>
默认值:full

Specifies what content type to download.

可用选项:
full,
video_only,
audio_only,
all_audio_tracks,
all_audio_tracks+video,
none
captions
boolean
默认值:false

Whether to download available captions or subtitles for the video.

captions_format
enum<string>
默认值:vtt

The file format for downloaded captions. Only applies when captions is true. Supported formats: vtt, srt, json3.

可用选项:
vtt,
srt,
json3
min_height
integer

Minimum accepted video resolution, expressed as a vertical pixel count. The download proceeds only if a resolution at or above this height is available. Common values: 360, 480, 720, 1080, 1440, 2160.

示例:

720

max_height
integer

Maximum accepted video resolution, expressed as a vertical pixel count. The download proceeds only if a resolution at or below this height is available. Common values: 360, 480, 720, 1080, 1440, 2160.

示例:

1440

thumbnail
boolean
默认值:false

Whether to include the video's thumbnail image in the results.

storyboards
boolean
默认值:false

Whether to include the video's storyboard images (sprite sheets used for timeline preview scrubbing) in the results.

响应

Job accepted successfully.

success
boolean

true when the job was accepted.

inputs
integer

Number of download jobs submitted.

job_id
string

Unique identifier for the submitted job.