Skip to main content
POST
/
v1
/
video
/
template2video
Template To Video
curl --request POST \
  --url https://api.domoai.com/v1/video/template2video \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "template": "kissing_screen",
  "prompt": "The girl kiss the screen.",
  "image": {
    "bytes_base64_encoded": "/9j/4AAQSkZJRgABAQAAAQABAAD/2w..."
  },
  "callback_url": "https://example.com/callback",
  "seconds": 5
}
'
{
  "data": {
    "task_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  },
  "code": 0
}
Read Templates to see all available templates

Authorizations

​
Authorization
string
header
required

API Key Bearer Token

Body

application/json
​
template
enum<string>
required
Available options:
kissing_screen,
looping_animation,
hug,
groove_dance,
kiss,
french_kiss,
360_view,
zoom_in,
zoom_out,
crane_up
​
images
ImageInput · object[]
required

Array of input images. Currently supports only one image. Multiple images may be supported in the future.

Minimum array length: 1
Examples:
[
  {
    "domoai_uri": "domoai://eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJvcmdhbml6YXRpb25faWQiOiIwNjhmZWViMy1hYmVkLTcyYTItODAwMC1hZDM1ZTg0ZGIxNDAiLCJ1cGxvYWRfYnVja2V0IjoiZW50LWFwaS10ZXN0LTEzMzYyODM0MDgiLCJ1cGxvYWRfa2V5IjoiZXBoZW1lcmFsLXVwbG9hZHMvMDY4ZmVlYjMtYWJlZC03MmEyLTgwMDAtYWQzNWU4NGRiMTQwLzI1YjhmOTgwLWM2MzEtNGQ1NC05Y2VhLTU0ZGFiYjhiMjYwNy9maWxlLm1wMyIsInR5cGUiOiJlcGhlbWVyYWwiLCJjb250ZW50X3R5cGUiOiJhdWRpby9tcGVnIiwiZmlsZV9zaXplIjoxMjU2MzIsImlhdCI6MTc2ODM4NzA3MCwiZXhwIjoxNzY4NDczNDcwLCJpc3MiOiJodHRwOi8vemhtLWFwaS5mcnAtZGV2LmRvbW8uY29vbC8ifQ.E60fIHPeDtEE0NmKaPGRYtyQJtaEQI9I0aNEwgtsLrg"
  }
]
[
  {
    "bytes_base64_encoded": "/9j/4AAQSkZJRgABAQAAAQABAAD/2w..."
  }
]
​
seconds
integer
required

Output video duration in seconds.

Required range: 1 <= x <= 10
​
callback_url
string<uri> | null

Callback notification URL for task results. If configured, the server will actively send notifications when the task status changes. The message schema of the notification can be found in the Callback Protocol section.

Required string length: 1 - 2083
Example:

"https://example.com/callback"

​
prompt
string
default:""
Maximum string length: 2000
​
aspect_ratio
enum<string> | null

Output video aspect ratio. If null or not provided, the system will automatically detect and use the closest matching ratio based on the input image.

Available options:
16:9,
9:16,
1:1,
4:3,
3:4
Example:

"16:9"

Callbacks

POST
{$request.body.callback_url}task_status_callback

Body

application/json
​
task_id
string<uuid>
required
​
id
string<uuid>
required
​
status
enum<string>
required
Available options:
PENDING,
QUEUING,
PROCESSING,
SUCCESS,
FAILED,
CANCELED
​
category
enum<string>
required
Available options:
TEXT_TO_VIDEO,
IMAGE_TO_VIDEO,
VIDEO_TO_VIDEO,
TEMPLATE_TO_VIDEO,
TALKING_AVATAR
​
callback_url
string | null
required
​
seconds
integer
required
​
output_videos
DomoVideoOut · object[]
required
​
credits
integer
required
​
inputs
Inputs · object
required
​
created_at
string | null
required

Response

Successful Response

Response

Successful Response

​
data
TaskOut · object
required
​
code
integer
default:0