Skip to main content

GET Live Thumbnail Image

Overview

The table below provides information about the GET method for retrieving a thumbnail image from a live video by its ID.

GET Live Thumbnail Image
MethodGET
URL or Endpointhttps://cdn.vpplayer.tech/projectId/images/videoId/live-thumbnail.fileFormat
ParametersprojectId, videoId, fileFormat, width, height
BodyNot Applicable

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

Parameter NameLocationMandatoryTypeDescription
projectIdPathYesstringUnique ID of the project.
videoIdPathYesstringUnique ID of the video.
fileFormatPathYesstringImage format (jpg, jpeg, and webp are supported).
widthQueryNointegerWidth of the output thumbnail image.
heightQueryNointegerHeight of the output thumbnail image.

Request Body

The GET method does not require a request body.

Response

If the image generation is successful, a 200 OK response will return the thumbnail image in the requested format.

If the image is still being processed, the response may return a 202 Accepted status with a plain text message:

The image generation request is still being processed! Please try again!

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