Bulk upload

Start an asynchronous bulk import from an S3 bucket. Returns job_id; poll lookup until COMPLETED or FAILED.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Start an asynchronous bulk import of media objects from an Amazon S3 bucket you control. The API returns a job_id; poll Lookup bulk upload until status is COMPLETED or FAILED.

POST /v2/bulk-uploads

ℹ️

Authenticate with X-Api-Key and send X-Format: default. JSON bodies need Content-Type: application/json. A successful create returns 200 with { "job_id": "…" }.

IAM credentials must allow s3:ListBucket on the bucket and s3:GetObject on the objects to import. Pass the bucket region (for example eu-north-1).

Only upload_type: s3 is accepted. Object keys currently processed are those ending in .mp4 or .mp3. Other extensions in the same bucket are skipped.

unique_upload_name must be unique on the account. Reusing a name returns 400.

While a job is running, lookup may keep showing STARTED with nb_success / nb_failed still "0" until the job finishes - poll until a terminal status. Successful objects become VOD assets (listed under List videos; the VOD title typically matches the S3 object key).

FieldRequiredNotes
unique_upload_nameyesUnique label for this job.
upload_typeyesMust be s3.
bucket_nameyesS3 bucket name.
regionyesAWS region of the bucket.
iam_access_keyyesIAM access key id.
iam_secret_tokenyesIAM secret access key.

See also Lookup bulk upload and List bulk uploads.

Body Params
string
required

Unique name for this upload job on the account.

string
enum
required

Source type. Only s3 is accepted.

Allowed:
string
required

S3 bucket name.

string
required

AWS region of the bucket.

string
required

IAM access key id with ListBucket + GetObject.

string
required

IAM secret access key.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json