Animation

post

https://api.immersity.ai/api/v1/animation

This API allows you to generate a captivating 3D animation. By utilizing the input disparity map and a single image, this generates an immersive 3D animation that adds depth and realism to the image.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

The input parameters for the animation generation.

inputImageUrl

string

required

Readable input image url

resultPresignedUrl

string

Presigned URL where the service should write the results to. The URL MUST have 'PUT' permission so the service can write the result to. For more details about signed URLs, please refer to your respective cloud providers.

correlationId

string

UUID to correlate this request. This must be unique for each request. If not provided, the service will generate one

inputDisparityUrl

string

required

Readable input disparity url

animationType

string

enum

Defaults to mp4

Type of animation

Allowed:

pattern

string

Pattern for the animation. This controls the position from which the 3D scene is viewed for each frame of the resulting video. Specify a comma-separated list of floats. The order of these values is as follows {x1,y1,z1,x2,y2,z2…xn,yn,zn} where x1,y1,z1 are the x, y, z coordinates in 3D space for the first frame, x2,y2,z2 for the next frame and so forth. Add as many coordinate triplets as there are frames in the video that you want to create. Animation length is ignored when using this parameter since length is determined by the number of frames that are placed. Also the amplitude and phase parameters are ignored since here you explicitly set the position rather than having it calculated

animationLength

number

1 to 10

Defaults to 4

Duration of the animation. This controls how fast or slow the animation should be. For example, a value of 1 would create the fastest and 10 would create the slowest animations.

outputWidth

number

Defaults to Equals to input width

Output image width

outputHeight

number

Defaults to Equals to input height

Output image height

amplitudeX

number

0 to 10

Defaults to 1

Amount of motion in X axis.

amplitudeY

number

0 to 10

Defaults to 1

Amount of motion in Y axis.

amplitudeZ

number

0 to 10

Defaults to 1

Amount of motion in Z axis.

phaseX

number

0 to 7

Defaults to 0

The starting point or offset of the motion in the x-axis. For example, a phase value of 0 indicates that the motion starts from the origin.

phaseY

number

0 to 7

Defaults to 0.25

The starting point or offset of the motion in the Y-axis. For example, a phase value of 0 indicates that the motion starts from the origin.

phaseZ

number

0 to 7

Defaults to 0.25

The starting point or offset of the motion in the Z-axis. For example, a phase value of 0 indicates that the motion starts from the origin.

gain

number

0 to 10

Defaults to Gain is estimated automatically based on input image for best results

Floating point gain value

convergence

number

-1 to 1

Defaults to Convergence is estimated automatically based on input image for best results

This sets the pivot point of the animation. At this depth nothing moves and everything else moves around this point.

numberOfLoops

number

0 to 10

Defaults to 0

Number of times the animation should loop. If not provided, the animation will not loop.

outputFps

number

Defaults to auto

FPS for the output video. Possible values are : 1,5,10,15,24,25,30,60

Responses

400

The request has invalid parameters

401

Returned if the user is not authenticated or authentication parameters are invalid

402

Returned it there is not enough credit balance

200The request has succeeded