POST Live Animated Image

Overview

The table below provides information about the POST method for generating the animated image from a live video by its ID.

POST Live Animated Image
Method	POST
URL or Endpoint	https://image.vpplayer.net/`projectId`/images/`videoId`/live-animated.`fileFormat`
Parameters	projectId, videoId, fileFormat, duration, fps, width
Body	Not Applicable

The description of the URL and query parameters is as follows:

Parameter Name	Location	Mandatory	Type	Description
`projectId`	Path	Yes	string	Unique ID of the project.
`videoId`	Path	Yes	string	Unique ID of the video.
`fileFormat`	Path	Yes	string	Image format (webp and gif are supported).
`duration`	Query	No	integer	Duration in seconds of the animation to be generated.
`fps`	Query	No	integer	Frames per second for the animation.
`width`	Query	No	integer	Width of the output image.

No request body is required for this POST method.

If the request has been accepted successfuly, the response will return a 200 OK status with a plain text message:

Request has been accepted and it is being processed.

For information about the errors that are common to all actions, see Common Errors: