Python

from magic_hour import Client
from os import getenv

client = Client(token=getenv("API_TOKEN"))
res = client.v1.files.upload_urls.create(
    items=[
        {"extension": "mp4", "type_": "video"},
        {"extension": "mp3", "type_": "audio"},
    ]
)

{
  "items": [
    {
      "upload_url": "https://videos.magichour.ai/api-assets/id/video.mp4?auth-value=1234567890",
      "expires_at": "2024-07-25T16:56:21.932Z",
      "file_path": "api-assets/id/video.mp4"
    },
    {
      "upload_url": "https://videos.magichour.ai/api-assets/id/audio.mp3?auth-value=1234567890",
      "expires_at": "2024-07-25T16:56:21.932Z",
      "file_path": "api-assets/id/audio.mp3"
    }
  ]
}

Files

Generate asset upload urls

Generates a list of pre-signed upload URLs for the assets required. This API is only necessary if you want to upload to Magic Hour’s storage. Refer to the Input Files Guide for more details.

The response array will match the order of items in the request body.

Valid file extensions per asset type:

video: mp4, m4v, mov, webm
audio: mp3, mpeg, wav, aac, aiff, flac, webm
image: png, jpg, jpeg, heic, webp, avif, jp2, tiff, bmp

Note: gif is only supported for face swap API video_file_path field.

Once you receive an upload URL, send a PUT request to upload the file directly.

Example:

curl -X PUT --data '@/path/to/file/video.mp4' \
  https://videos.magichour.ai/api-assets/id/video.mp4?<auth params from the API response>

POST

files

upload-urls

Python

from magic_hour import Client
from os import getenv

client = Client(token=getenv("API_TOKEN"))
res = client.v1.files.upload_urls.create(
    items=[
        {"extension": "mp4", "type_": "video"},
        {"extension": "mp3", "type_": "audio"},
    ]
)

{
  "items": [
    {
      "upload_url": "https://videos.magichour.ai/api-assets/id/video.mp4?auth-value=1234567890",
      "expires_at": "2024-07-25T16:56:21.932Z",
      "file_path": "api-assets/id/video.mp4"
    },
    {
      "upload_url": "https://videos.magichour.ai/api-assets/id/audio.mp3?auth-value=1234567890",
      "expires_at": "2024-07-25T16:56:21.932Z",
      "file_path": "api-assets/id/audio.mp3"
    }
  ]
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".

Body

application/json

Body

items

object[]

required

The list of assets to upload. The response array will match the order of items in the request body.

Minimum array length: 1

Show child attributes

items.type

enum<string>

required

The type of asset to upload. Possible types are video, audio, image

Available options:

video,

audio,

image

Example:

"video"

items.extension

string

required

The extension of the file to upload. Do not include the dot (.) before the extension. Possible extensions are mp4,m4v,mov,webm,mp3,wav,aac,flac,webm,png,jpg,jpeg,heic,webp,avif,jp2,tiff,bmp

Example:

"mp4"

Example:

[
  { "type": "video", "extension": "mp4" },
  { "type": "audio", "extension": "mp3" }
]

Response

Success

items

object[]

required

The list of upload URLs and file paths for the assets. The response array will match the order of items in the request body. Refer to the Input Files Guide for more details.

Show child attributes

items.upload_url

string<uri>

required

Used to upload the file to storage, send a PUT request with the file as data to upload.

Example:

"https://videos.magichour.ai/id/video.mp4?auth-value=1234567890"

items.expires_at

string<date-time>

required

when the upload url expires, and will need to request a new one.

Example:

"2024-07-21T17:32:28Z"

items.file_path

string

required

this value is used in APIs that needs assets, such as image_file_path, video_file_path, and audio_file_path

Example:

"video/id/1234.mp4"

Example:

[
  {
    "upload_url": "https://videos.magichour.ai/api-assets/id/video.mp4?auth-value=1234567890",
    "expires_at": "2024-07-25T16:56:21.932Z",
    "file_path": "api-assets/id/video.mp4"
  },
  {
    "upload_url": "https://videos.magichour.ai/api-assets/id/audio.mp3?auth-value=1234567890",
    "expires_at": "2024-07-25T16:56:21.932Z",
    "file_path": "api-assets/id/audio.mp3"
  }
]

Get face detection details

⌘I

Files

Video Projects

Image Projects

Audio Projects

Generate asset upload urls

Authorizations

Body

Response