Media assets

Prepare media asset upload

Prepare a media asset upload for use in world generation.

This API endpoint creates a media asset record and returns a signed upload URL. Use this workflow to upload images or videos that you want to reference in world generation requests.

Workflow

Prepare Upload (this endpoint): Get a media_asset_id and upload_url
Upload File: Use the signed URL to upload your file
Generate World: Reference the media_asset_id in /worlds:generate with source type “media_asset”

Request Parameters

file_name: Your file’s name (e.g., “landscape.jpg”)
extension: File extension without dot (e.g., “jpg”, “png”, “mp4”)
kind: Either “image” or “video”
metadata: Optional custom metadata object

Response

Returns a MediaAssetPrepareUploadResponse containing:

media_asset: Object with media_asset_id (use this in world generation)
upload_info: Object with upload_url, required_headers, and curl_example

Uploading Your File

Use the returned upload_url and required_headers to upload your file:

curl --request PUT \
  --url <upload_url> \
  --header "Content-Type: <content-type>" \
  --header "<header-name>: <header-value>" \
  --upload-file /path/to/your/file

Replace:

<upload_url>: The upload_url from the response
<content-type>: MIME type (e.g., image/png, image/jpeg, video/mp4)
<header-name>: <header-value>: Each header from required_headers
/path/to/your/file: Path to your local file

Example Usage in World Generation

After uploading, use the media_asset_id in a world generation request:

{
  "world_prompt": {
    "type": "image",
    "image_prompt": {
      "source": "media_asset",
      "media_asset_id": "<your-media-asset-id>"
    }
  }
}

POST

marble

media-assets:prepare_upload

Prepare a media asset upload

curl --request POST \
  --url https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload \
  --header 'Content-Type: application/json' \
  --header 'WLT-Api-Key: <api-key>' \
  --data '
{
  "file_name": "<string>",
  "extension": "mp4",
  "metadata": {}
}
'

import requests

url = "https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload"

payload = {
    "file_name": "<string>",
    "extension": "mp4",
    "metadata": {}
}
headers = {
    "WLT-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'WLT-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({file_name: '<string>', extension: 'mp4', metadata: {}})
};

fetch('https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'file_name' => '<string>',
    'extension' => 'mp4',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "WLT-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload"

	payload := strings.NewReader("{\n  \"file_name\": \"<string>\",\n  \"extension\": \"mp4\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("WLT-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload")
  .header("WLT-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file_name\": \"<string>\",\n  \"extension\": \"mp4\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["WLT-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file_name\": \"<string>\",\n  \"extension\": \"mp4\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "media_asset": {
    "created_at": "2023-11-07T05:31:56Z",
    "file_name": "<string>",
    "media_asset_id": "<string>",
    "extension": "mp4",
    "metadata": {},
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "upload_info": {
    "upload_method": "<string>",
    "upload_url": "<string>",
    "curl_example": "<string>",
    "required_headers": {}
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

WLT-Api-Key

string

header

required

API key for authentication. Get your key from the developer portal.

Body

application/json

Request to prepare a media asset upload.

file_name

string

required

File name

Maximum string length: 64

kind

enum<string>

required

High-level media type

Available options:

image,

video

Examples:

"image"

"video"

extension

string | null

File extension without dot

Example:

"mp4"

metadata

Metadata · object | null

Optional application-specific metadata

Response

Successful Response

Response from preparing a media asset upload.

media_asset

MediaAsset · object

required

The created media asset

Show child attributes

upload_info

UploadUrlInfo · object

required

Upload URL information

Show child attributes

Get media assetGet a media asset by ID. Retrieves metadata for a previously created media asset. Args: media_asset_id: The media asset identifier. Returns: MediaAsset object with media_asset_id, file_name, extension, kind, metadata, created_at, and updated_at. Raises: HTTPException: 404 if not found

⌘I

Prepare a media asset upload

curl --request POST \
  --url https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload \
  --header 'Content-Type: application/json' \
  --header 'WLT-Api-Key: <api-key>' \
  --data '
{
  "file_name": "<string>",
  "extension": "mp4",
  "metadata": {}
}
'

import requests

url = "https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload"

payload = {
    "file_name": "<string>",
    "extension": "mp4",
    "metadata": {}
}
headers = {
    "WLT-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'WLT-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({file_name: '<string>', extension: 'mp4', metadata: {}})
};

fetch('https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'file_name' => '<string>',
    'extension' => 'mp4',
    'metadata' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "WLT-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload"

	payload := strings.NewReader("{\n  \"file_name\": \"<string>\",\n  \"extension\": \"mp4\",\n  \"metadata\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("WLT-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload")
  .header("WLT-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"file_name\": \"<string>\",\n  \"extension\": \"mp4\",\n  \"metadata\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.worldlabs.ai/marble/v1/media-assets:prepare_upload")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["WLT-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"file_name\": \"<string>\",\n  \"extension\": \"mp4\",\n  \"metadata\": {}\n}"

response = http.request(request)
puts response.read_body

{
  "media_asset": {
    "created_at": "2023-11-07T05:31:56Z",
    "file_name": "<string>",
    "media_asset_id": "<string>",
    "extension": "mp4",
    "metadata": {},
    "updated_at": "2023-11-07T05:31:56Z"
  },
  "upload_info": {
    "upload_method": "<string>",
    "upload_url": "<string>",
    "curl_example": "<string>",
    "required_headers": {}
  }
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Get started

Examples

Reference

Support & billing

Prepare media asset upload

Workflow

Request Parameters

Response

Uploading Your File

Example Usage in World Generation

Authorizations

Body

Response