POST Animated Image
Overview
The table below provides information about the POST method for generating an animated image from a video by its ID.
| POST Animated Image | |
|---|---|
| Method | POST |
| URL or Endpoint | https://image.vpplayer.net/projectId/images/videoId/animated.fileFormat |
| Parameters | projectId, videoId, fileFormat, start, end, fps, width |
| Body | Not Applicable |
URL and Parameters
The following table describes the path and query parameters used with this endpoint:
| 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). |
start | Query | No | integer | Time in seconds within the video timeline at which the animation should start. |
end | Query | No | integer | Time in seconds within the video timelines at which the animation should end. |
fps | Query | No | integer | Frames per second for the animation. |
width | Query | No | integer | Width of the output image. |
Request Body
The POST method does not require a request body.
Response
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.
Errors
For information about the errors that are common to all actions, see Common Errors:
HTTP Status Code 400: Bad Request
HTTP Status Code 401: Unauthorized
HTTP Status Code 403: Forbidden
HTTP Status Code 404: Result Not Found
HTTP Status Code 500: Internal Server Error
HTTP Status Code 503: Backend Fetch Failed