Media

This API creates a new media from your image files, image URLs or text prompt. If you upload 2 images or submit with 2 image URLs, those 2 files are considered as start and end frame of the video. If you upload only 1 file or give 1 image URL, a new video will be generated from uploaded image. If you don't upload or give any image, a new video will be generated from the prompt.

Send a POST request to create a new media. This will return newly created media information. The request should include your API key.

Here are examples of how to create a media with each types of data.

Example Code

Create a new Media with two image files.

import requests

url = "https://api.vimmerse.net/media"

payload = {
  'title': 'New Media example with Two images upload'
}

files=[
  ('image_files',('start_frame.png',open('path/to/your/start_frame.png','rb'),'image/png')),
  ('image_files',('end_frame.png',open('path/to/your/end_frame.png','rb'),'image/png')), ## if you omit this line, a new video is generated by referencing only start_frame.png
]
headers = {
  'X-Api-Key': 'YOUR_API_KEY'
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Create a new Media with image URLs and motion type.

import requests

url = "https://api.vimmerse.net/media"

payload = {
  'title': 'New Media example with 2 image URLs, generate 2 video with motion type.',
  'image_urls': [
      'https://example.com/path/to/your/start_frame.png',
      'https://example.com/path/to/your/end_frame.png',
    ],
  'motion_type': 'KlingAI',
  'quantity': 2
}

headers = {
  'X-Api-Key': 'YOUR_API_KEY'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

Create a new Media with text prompt and add sound effect.

import requests

url = "https://api.vimmerse.net/media"

payload = {
  'title': 'New Media example with text prompt and sound effects.',
  'prompt': "Generate a video that bunny jumps into the forest.",
  'sound_effects': 'Yes'
}

headers = {
  'X-Api-Key': 'YOUR_API_KEY'
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

This API retrieves media processing status in percentage.

Send a GET request to get media processing status.

Example Code

Get processing status of the media.

import requests

url = "https://api.vimmerse.net/media/{MEDIA_ID}/processing-status"

headers = {
  'X-Api-Key': 'YOUR_API_KEY'
}

response = requests.request("GET", url, headers=headers)

print(response.text)

This API retrieves a media object.

Send a GET request to get your media.

Example Code

Read Media example.

import requests

url = "http://api.vimmerse.net/media/{MEDIA_ID}"

headers = {
    'X-Api-Key': 'YOUR_API_KEY'
}

response = requests.request("GET", url, headers=headers)

print(response.text)

This API updates media and resubmit again if you update any of prompt, motion_type, quantity, duration, loop, aspect_ratio and sound_effects. If media is processed again, it will reduce your credit.

Send a PUT request to update your media. This will return updated media. The request should include your API key.

Example Code

Update Media without resubmitting example

import requests

url = "http://api.vimmerse.net/media/{MEDIA_ID}/edit"

headers = {
    'X-Api-Key': 'YOUR_API_KEY',
}

payload = {
    'title': 'New Updated Title',
    'rating: '5',
    'visibility_status': '2'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

Update Media with resubmitting example

import requests

url = "http://api.vimmerse.net/media/{MEDIA_ID}/edit"

headers = {
    'X-Api-Key': 'YOUR_API_KEY',
}

payload = {
    'title': 'New Updated Title',
    'motion_type: 'RunwayML',
    'duration': 9
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)

Downloads file from media.

Example Code

This code shows an example of how to download Bullet Video from Auto motion.

import requests

url = "https://api.vimmerse.net/media/{MEDIA_ID}/download?object_type=bullet_video_mp4&motion_type=Auto"

headers = {
  'X-Api-Key': 'YOUR_API_KEY'
}

response = requests.request("GET", url, headers=headers)

print(response.text)

This code shows an example of how to download Bullet Video with custom settings

import requests

url = "https://api.vimmerse.net/media/{MEDIA_ID}/download?object_type=bullet_video_mp4&motion_type=Auto&width=1080&file_size=4"

headers = {
  'X-Api-Key': 'YOUR_API_KEY'
}

response = requests.request("GET", url, headers=headers)

print(response.text)

This API resubmit to generate a bullet video.

Example Code

Send a POST request without body to resubmit your media.

import requests

url = "https://api.vimmerse.net/media/{MEDIA_ID}/process"

headers = {
  'X-Api-Key': 'YOUR_API_KEY'
}

response = requests.request("POST", url, headers=headers)

print(response.text)