Skip to main content
POST
Upload an asset
Upload an image or video by providing a publicly accessible URL. The asset is downloaded and processed asynchronously.

Usage Flow

  1. Call POST /assets with the asset URL, name, and type
  2. Receive the asset ID with status: PROCESSING
  3. Poll GET /assets/{id} until status is READY
  4. Use the asset ID in POST /videos with broll.type: UPLOAD

Example


Authorizations

x-api-key
string
header
required

API key to be included in the x-api-key header

Body

application/json
name
string
required

Display name for the asset

Required string length: 1 - 256
type
enum<string>
required

Asset type. Audio upload is not supported.

Available options:
IMAGE,
VIDEO
url
string<uri>
required

Publicly accessible URL to download the asset from

Response

Duplicate asset found — existing asset returned

id
string<uuid>
name
string | null
type
enum<string>
Available options:
AUDIO,
IMAGE,
VIDEO
status
enum<string>

Processing status. Poll until READY before using as B-roll.

Available options:
PROCESSING,
READY,
FAILED
fileUrl
string | null

URL to access the asset. Null while processing.

thumbnailUrl
string | null

URL to a thumbnail image. Null while processing.

createdAt
string<date-time>