Skip to content
VIDMOATDocs

Bring a still to life

POSThttps://api.vidmoat.com/v1/ai/live-images
Bearer tokenScope ai.video8 credits per secondTry it in the playground

vidmoat-image-live-1 (pilot, enabled per account): animate a still with a depth-parallax camera move, ambient motion in one region, or a gentle object motion. Only what the still already shows moves. Returns a job to poll.

Body#

  • imageobjectrequired
    { "url": "https://..." } or { "uploadId": "..." } (an upload in your account). imageUrl is accepted instead.
  • promptstringrequired
    The motion, up to 500 characters: "slow push-in", "steam rises from the cup", "the sneaker floats".
  • durationSecintegerdefault 5
    Whole seconds, 2 to 10. Billed on exactly this number.
  • aspectRatioenumdefault source
    Output is 720p on the short side.
    One of source, 16:9, 9:16, 1:1, 4:5, 5:4, 4:3, 3:4
  • modeenumdefault auto
    Force the method instead of reading it from the prompt.
    One of auto, camera, ambient, object
  • moveenum
    Camera move.
    One of push, pull, drift, orbit, pan
  • regionstring
    What moves in ambient mode: water, waterfall, waves, clouds, smoke, steam, fire, leaves, wheat, grass, hair, flag, curtain and more.
  • motionenum
    Object motion on the cut-out subject.
    One of float, bob, sway, tilt, drive
  • directionenum
    Direction of the move or flow.
    One of up, down, left, right
  • strengthnumberdefault 1
    0.25 to 2.
  • boxobject
    { x, y, width, height } as fractions of the frame: where the region or subject is.
  • loopbooleandefault false
    Make the end meet the start. One-way moves (push, pull, drift, pan, drive) cannot loop and are refused.
  • seedinteger
    For a repeatable result.
  • projectIdstring
    Project to attach the job to.
  • maxCreditsnumber
    Never spend more than this.
  • quoteOnlyboolean
    true returns the tier, method and price without starting a job.

Response#

Returns 202.

Response fields#

  • idstring
    The job id. Poll it with Get a generation job.
  • statusstring
    PROCESSING.
  • quoteobject
    { credits, tier, motionClass, method }.
  • creditsobject
    { charged, remaining, basis }.
  • pollstring
    The path to poll.

Errors#

Besides the errors any request can get (authentication, rate limits):

StatusCodeWhen
400invalid_requestNo image or prompt, an unsupported option, a motion only Generate a video can make, or a quote above maxCredits.
402plan_requiredLiving images are not enabled on the account.
402insufficient_creditsThe balance cannot cover the call. Nothing ran. remaining is the balance.
402quota_exceededA living image is already being made on the account.
501not_configuredThe living-image worker is not available on this deployment.
422prompt_rejectedThe prompt failed the safety check. Nothing was charged. field names the field.