Story

This API simply creates a story from idea. You can use 3 advanced steps to create your story video step by step.

Send a POST request with your idea.

Example Code

import requests

url = "https://api.vimmerse.net/story/idea-2-video"

headers = {
    'X-Api-Key': 'YOUR_API_KEY',
}
payload = {
    'idea': 'Make promotion video that cute animals play the musical instruments.',
    'title': 'Example Story',
    'aspect_ratio': '9:16',
    'scene_count': 3
}

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

print(response.text)

This API creates a new Story and storyboard from idea.

Send a POST request with your idea and scene_count if you have in your mind.

Example Code

import requests

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

headers = {
    'X-Api-Key': 'YOUR_API_KEY',
}
payload = {
    'idea': 'Generate a Shonen style story that Bunny walk through forest and find outs honey is flowing and try to drink, and impressed.'
    'scene_count': 3,
    'title': 'Example Story',
}

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

print(response.text)

This API crafts images of your characters, objects and environments and background music from your storyboard.

Send a POST request with/without storyboard to generate element images from your storyboard. If you already have images for your 'characters', 'objects' or 'environments', you can just add URL under same level of name and description field of each scene. if you already have background music, you can just add music_url under music object under storyboard.

Example Code

import requests

url = "https://api.vimmerse.net/story/{STORY_ID}/elements"

payload = {
    'aspect_ratio': '16:9',
    'option': 'FluxKontextPro'
    'seed': 4669,
}
headers = {
    'X-Api-Key': 'YOUR_API_KEY'
}

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

print(response.text)

This API crafts missing images and narrations of scenes in storyboard.

Send a POST request to generate images from storyboard.

Example Code

Generate scene images without updating storyboard.

import requests

url = "https://api.vimmerse.net/story/{STORY_ID}/scenes"

payload = {
    'aspect_ratio': '16:9',
    'option': 'FluxKontextPro'
    'seed': '4669',
}
headers = {
    'X-Api-Key': 'YOUR_API_KEY'
}

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

print(response.text)

Generate scene images with updating storyboard.

import requests

url = "https://api.vimmerse.net/story/{STORY_ID}/scenes"

payload = {
    'aspect_ratio': '16:9',
    'seed': '4669',
    'option': 'FluxKontextPro'
    'storyboard': json.dumps({...storyboard})
}
headers = {
    'X-Api-Key': 'YOUR_API_KEY'
}

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

print(response.text)

This API requests to create video from storyboard and scenes

You can see medias generated from response and once all medias are finished, your story video will be available at URL of video_url.

Example Code

Create story video without updating scenes.

import requests

url = "https://api.vimmerse.net/story/{STORY_ID}/videos"

payload = {
    "title": "Example story from vimmerse",
    "motion_type": "KlingAI",
}

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

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

print(response.text)

Create story video with updating storyboard and scenes.

import requests

url = "https://api.vimmerse.net/story/{STORY_ID}/videos"

payload = {
    "title": "Example story video from vimmerse",
    "storyboard": {...storyboard},
    "scenes": {...scenes}
}

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

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

print(response.text)

This API retrieves a Story object.

status field shows current progressing status of this Story.

if Story is finished, you can get composed video from video_url. Send a GET request to get your story video.

Example Code

Get a new Story example

import requests

url = "http://api.vimmerse.net/story/{STORY_ID}"

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

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

print(response.text)

This API requests to compose all videos from Story. You can get composed video from video_url after videos are composed.

Send a POST request with empty body.

Example Code

Compose all video from media. Simple submit without data.

import requests

url = "http://api.vimmerse.net/story/{STORY_ID}/concat"

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

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

print(response.text)