For the complete documentation index, see llms.txt. This page is also available as Markdown.

Video Generation

Video generation transforms design images into short animated clips. It supports Home, Interior, Exterior, and Garden designs. The system adds motion and smooth visual transitions. This helps users explore designs in a more interactive way.

ENDPOINT

POST /video_generation

An API URL would be like https://homedesigns.ai/api/v2/video_generation

Use this endpoint to generate videos instantly from the image. The Video Generation API leverages AI to create dynamic visual content.

An API request must be in the form-data format.

Request

Parameters & Data Type
Value
Description

image

file[ .jpg, .jpeg, .png] / base64 Image string

-

The image to be processed by the API. The image dimensions must be 512x512 pixels or greater for optimal results. (Required Parameter)

tool_name

string

The tool_name should be in [pan_up, pan_down, pan_left_right, zoom_in, zoom_out, camera_pullback, rotate_cw, rotate_ccw, combining_motions, look_up, look_down].

Create dynamic design videos using camera effects like Pan, Zoom, Rotate, Pullback, etc. Add smooth motion to make your Home, Interior, Exterior, and Garden designs more realistic.(Required Parameter)

Parameters & Errors

image

Error Messages
Reason

Image field required

Image not provided

Invalid image size. The image width and height must be 512x512 or greater than 512x512 pixels.

Image Size Not Proper.

Invalid image format. Only PNG, JPEG and JPG images are allowed.

Image Format not valid.

tool_name

Error Messages
Reason

tool_name field required

Tool name not provided

tool_name value is not a valid enumeration member; permitted: 'pan_up'

Tool name not provided properly

status_check

Error Messages
Reason

Please Enter a Valid Queue ID

Invalid queue ID.

//Output should be in list of array depends on no of designs as shown below:

{
    "input_image": "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/input-77a61d7d-1fc6-4911-924b-fb05b4d9b76d-2026-03-31-07-16-30.png",
    "output_video": "https://storage.googleapis.com/generativeartbucket/UserGenerations/cristian/imageToClip/videos-807cdcca-2957-49b4-b4b4-282fcaf5d020-2026-03-31-07-17-25-video.mp4"
}

Process for Using /video_generation and /video_generation/status_check Endpoints

GET https://homedesigns.ai/api/v2/video_generation/status_check/ag61df25b20-e263-4bae-vbgbae8-ecccaafgbbd687-ugf1

  1. Step 1: Pass Required Parameters to /video_generation

    • When you send a request to the /video_generationendpoint with all required parameters, it will generate a queue_id.

    • Example response from /video_generation:

      {
          "id": "ag61df25b20-e263-4bae-vbgbae8-ecccaafgbbd687-ugf1",
          "status": "IN_QUEUE"
      }
    • The queue_id (id value) from this response will be used in subsequent requests.


  1. Step 2: Use queue_id in /video_generation/status_checkEndpoint

    • Append the generated queue_id to the /video_generation/status_checkendpoint to check the processing status.

    • Example request:


  1. Step 3: Review the Status Response

    • The /video_generation/status_check endpoint will return the current status of the process. Initially, the status might indicate that the process is still in "starting" wait a few moments and send the request again.

    • Example response:

    • If the status is still pending "processing", wait a few moments and send the request again.

    • Example response:

    • Once all the statuses marked as IN_QUEUE , starting and processing are completed, after hitting the requests one by one, you will see the results as follows:


  1. Step 4: Get the Final Result

    • Continue checking the status by re sending the request to the /video_generation/status_check endpoint until the status changes to "SUCCESS".

    • When the status is "SUCCESS", you will receive the final result in the response.

    Tool name:

look_down

pan_up

pan_down

pan_left_right

zoom_in

camera_pullback

zoom_out

rotate_cw

rotate_ccw

combining_motions

look_up

Last updated