Search
Authentication
Media
Recommended flow
Error response format
post
Create Media
put
Update Media
get
Get Media
Workflow
Overview
Typical Lifecycle
How Workflows Work
Templates in use
Workflow Processing Steps
Webhook Integration
post
Create Workflow
get
Get Workflow Status
Story
Flows
Pricing for Auto Story Generation
Error response format
post
[AUTO] Idea-to-Video
post
[AUTO] URL-to-Video
post
[AUTO] Images-to-Video
post
[ADVANCED] Step 1 - Create Storyboard
post
[ADVANCED] Step 1.5 - Create Element Images (Optional)
post
[ADVANCED] Step 2 - Create Scenes
post
[ADVANCED] Step 3 - Create Videos
get
Get Story Detail
del
Delete Story
Image
post
Upload Image
post
Text to Image
post
Image to Image
post
Elements
post
Replace Background
post
Edit Image
post
Face Swap
post
Try On
post
Restyle
Text
post
Generate Text Prompt
Video
post
Upload Video
post
Crop Video
post
Reframe Video
post
Enhance Video
post
Add Sound Effect
post
Avatar Lip-Sync Video
post
Lip-Sync Video
post
Video Effects
post
Replace Background
post
Reference to Video
post
Video to Video
post
Attach Audio
Audio
post
Upload Audio
post
Text 2 Speech
post
Text 2 Sound Effect
post
Text 2 Music
Asset
get
Get Asset
Finetune
post
Create Finetune
get
Finetune Flux Pro/Dev
Statistics
get
Get daily statistics.
Other
get
Health
Media (Legacy)
post
Create Media
get
Get Media Processing Status
get
Get Media
put
Update Media
get
Download File
post
Process Media
Story (Legacy)
post
[AUTO] Idea-to-Video
post
[AUTO] URL-to-Video
post
[AUTO] Images-to-Video
post
[ADVANCED] Step 1 - Create Storyboard
post
[ADVANCED] Step 1.5 - Create Element Images(Optional)
post
[ADVANCED] Step 2 - Create Scenes
post
[ADVANCED] Step 3 - Create Videos
get
Get Story Detail
put
Update Story
del
Delete Story
put
Update Story General Info
post
Concat Story
Workflow (Legacy)
post
Create Workflow
get
Get Workflow Status
put
Update Workflow
del
Delete Workflow
post
Log Customer Script Error
Event
post
Create Event (User)
put
Update Event (User)
del
Delete Event (User)
get
Get Event (User)
get
List Events (User)
get
List Workflow Templates
post
Check Event Exists
post
Create Event (Admin)
put
Update Event (Admin)
del
Delete Event (Admin)
get
Get Event (Admin)
get
List Events (Admin)
Powered by Redocly
Other
Vimmerse health checker service.
Health
Check API health status.
Responses
200
Successful Response
get
/health
Try it
Request samples
curl
JavaScript
Python
Go
Node.js
Copy
Response samples
200
application/json
Copy
null
➔ Next to
Media (Legacy)