Generations
Video
Modify

Modify a video

Changed on

Modify a video with style transfer and prompt-based editing

post/generations/video/modify

Request

  • Base URL: https://api.lumalabs.ai/dream-machine/v1
  • URL: https://api.lumalabs.ai/dream-machine/v1/generations/video/modify
  • Auth: HTTP bearer

Request body

generation_type'modify_video' required
model'ray-2' | 'ray-flash-2' required

The model used for the modify video

mode'adhere_1' | 'adhere_2' | 'adhere_3' | 'flex_1' | 'flex_2' | 'flex_3' | 'reimagine_1' | 'reimagine_2' | 'reimagine_3' required

The mode of the modify video

promptstring

The prompt of the generation

callback_urlstring uri

The callback URL of the generation, a POST request with Generation object will be sent to the callback URL when the generation is dreaming, completed, or failed

Response

Video modified

idstring uuid

The ID of the generation

generation_type'video' | 'image'
state'queued' | 'dreaming' | 'completed' | 'failed'

The state of the generation

failure_reasonstring

The reason for the state of the generation

created_atstring date-time

The date and time when the generation was created

modelstring

The model used for the generation

Example response

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "state": "completed",
  "failure_reason": null,
  "created_at": "2023-06-01T12:00:00Z",
  "assets": {
    "video": "https://example.com/video.mp4"
  },
  "model": "ray-2",
  "request": {
    "prompt": "A serene lake surrounded by mountains at sunset",
    "aspect_ratio": "16:9",
    "loop": true,
    "keyframes": {
      "frame0": {
        "type": "image",
        "url": "https://example.com/image.jpg"
      },
      "frame1": {
        "type": "generation",
        "id": "123e4567-e89b-12d3-a456-426614174000"
      }
    }
  }
}

Changes

  • d1f79351570eRevision changes
    • info

      the response's property default value ray-1-6 was removed for the status

    • info

      removed the ray-1-6 enum value from the ///// response property for the response status

  • 965c8e97a488Revision changes
    • warning

      added the new ray-flash-2 enum value to the ///// response property for the response status

    • info

      added the new ray-flash-2 enum value to the request property