Skip to main content

POST Thumbnail Image from Original File

Overview

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

POST Thumbnail Image from Original File
MethodPOST
URL or Endpointhttps://image.vpplayer.net/projectId/images/videoId/thumbnail.fileFormat
ParametersprojectId, videoId, fileFormat, time, width, height
BodyNot Applicable

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

Parameter NameLocationMandatoryTypeDescription
projectIdPathYesstringUnique identifier for the project.
videoIdPathYesstringUnique identifier for the video.
fileFormatPathYesstringImage format (jpg, jpeg, and webp are supported).
timeQueryNointegerTime in seconds within the video timeline at which the thumbnail should be generated.
widthQueryNointegerWidth of the generated thumbnail.
heightQueryNointegerHeight of the generated thumbnail.

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