LogoLogo
  • Overview
  • Quick Start
  • Authentication
  • Rate limits
  • Errors
  • Image Editing API
    • Image I/O
    • Image Operations
      • Restorations
      • Resizing
      • Outpainting
      • Generative Editing
      • Color Adjustments
      • Background
      • Padding
      • Privacy
    • API Reference
    • Async API Reference
    • Batch API Reference
    • Upload API Reference
  • image generation api
    • Image Generation I/O
    • Image Generation Options
    • API Reference
  • AI Background API
    • AI Background I/O
    • AI Background Options
      • Object
      • Scene
      • Product Shadow
    • API Reference
  • Image to Video API
    • Image to Video I/O
    • Image to Video Options
    • Async API Reference
  • Storage Connectors
    • Overview
    • AWS S3
    • Google Cloud Storage
    • Web Folder
    • API Reference
  • Guides
    • E-commerce
    • Real Estate
    • Printing
  • Redoc
  • Blog
Powered by GitBook
On this page
  • Prompt
  • Negative prompt
  • Duration
  • Guidance scale
  • Possible values
Edit on GitHub
  1. Image to Video API

Image to Video Options

Learn how to control Image to Video generation.

Prompt

The Image to Video API accepts text prompts to define the result. Prompts can be generated automatically using Autoprompt AI or provided manually.

Autoprompt AI: Automatic prompt generation

Autoprompt AI analyzes the input product image and generates a text prompt tailored to create a contextually relevant video. This is useful for automating image to video generation, especially with large batches of images.

How to use it: Set the generate parameter to true within the prompt object in the options section of your API request.

{
    "options": {
        "prompt": {
            "generate": true
        }
    }
}

Custom prompts: Manual control

For more control over the background, provide your own prompt. Custom prompts must be between 3 and 5000 characters.

Example:

{
    "options": {
        "prompt": "The camera slowly rotates left to right around the burger with natural and realistic motion. Steam rises gently from the top, drifting upward. Bacon edges shift slightly from the heat. Melted cheese softens and begins to drip slowly. A thick drop of sauce slides down the side. The grilled patty glistens as it turns, showing juicy texture. Lettuce and tomato stay fresh and still. The bun gives off a soft heat shimmer. As the camera moves, the full burger looks hot, fresh, and ready to eat. The background shifts gently with it, keeping the burger centered. Soft, out-of-focus lighting moves across the backdrop, creating a rich, appetizing atmosphere."
    }
}

Negative prompt

The negative prompt is a parameter that specifies what you don't want to see on the generated video. When specified, it tells the generation process not to include things in the video that match a given text. The negative_prompt must be between 3 and 5000 characters.

{
    "options": {
        "prompt": {"generate": true},
        "negative_prompt": "blur, distort, and low quality"
    }
}

Duration

The duration parameter controls how long the generated video will be. It can be set to 5 seconds or 10 seconds.

{
    "options": {
        "prompt": {"generate": true},
        "duration": 5
    }
}

Guidance scale

The guidance scale controls how closely the generated video should match your prompt. You may adjust this scale to gain more control over the output.

Note that adjusting this scale may affect quality.

{
    "options": {
        "prompt": {"generate": true},
        "guidance_scale": 0.5
    }
}

Possible values

Parameter
Type
Range
Default value

prompt

string or object

3 - 5000

is required

negative_prompt

string

3 - 5000

duration

integer

5, 10

5

guidance_scale

float

0.0 - 1.0

0.5

PreviousImage to Video I/ONextAsync API Reference

Last updated 1 day ago