Search
Authentication
Workflow
Overview
Typical Lifecycle
How Workflows Work
Template catalog
Templates in use
Available Values for Options
Processing capabilities
Webhook Integration
post
Create Workflow
post
Estimate Credits
get
List Workflow Templates
get
Get Workflow Template
get
Get Workflow Status
Agent
Typical Agent Workflow (Async with Polling)
Common Use Cases
Endpoint Overview
Authentication
Quick Start Examples
post
Engage Agent
get
List Agent Profiles
get
Get Sessions of a User
get
Get Session
put
Update Session
del
Delete Session
get
Get Sessions of a Customer
Story
Flows
Estimate credits
Pricing for Auto Story Generation
Error response format
post
Estimate Credits
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
Media
Recommended flow
Error response format
post
Create Media
post
Estimate Credits
put
Update Media
get
Get Media
Video
Endpoints
Workflow
Responses
Authentication
post
Upload Video
post
Estimate Credits
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
Image
Endpoints
Workflow
Responses
Authentication
post
Upload Image
post
Estimate Credits
post
Text to Image
post
Image to Image
post
Elements
post
Replace Background
post
Edit Image
post
Face Swap
post
Try On
Text
Endpoints
Media inputs
Authentication
post
Generate Text Prompt
post
Suggest Text Prompt
post
Image to Prompt
post
Refine Text Prompt
Audio
Endpoints
Workflow
Responses
Authentication
post
Upload Audio
post
Estimate Credits
post
Text 2 Speech
post
Text 2 Sound Effect
post
Text 2 Music
Asset
get
Get Asset
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 photobooth event payment checkout
post
Verify photobooth event payment session
post
Create Event (Admin)
put
Update Event (Admin)
del
Delete Event (Admin)
get
Get Event (Admin)
get
List Events (Admin)
Statistics
get
Get daily statistics.
Other
get
Health
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