Generate Video Thumbnail

550 atoms
Premium tier

About

The video thumbnail service lets you to generate a video thumbnail from any part of the given video file or url. We accept video files and urls of the videos for this utility, Youtube and Dailymotion urls are also accepted, but may encounter potential issues in terms of functionality and accessibility. These issues could arise due to alterations in their policies governing content sharing, embedding, or playback mechanisms.
Using this utility to extract thumbnails from videos can be automated, allowing for efficient and consistent extraction of thumbnails without the need for manual intervention. This can save time and resources for businesses and content creators. This can allow for the customization of thumbnail extraction parameters such as size, and duration.
This utility can be integrated into existing workflows and platforms, which makes it easy to incorporate thumbnail extraction into existing processes. This can help businesses and content creators streamline their operations and improve efficiency.
Endpoint Selector
Input
Output

API Playground

Documentation

input file: output file
POST
https://api.apyhub.com/generate/video-thumbnail/file

Request example

1
curl --location --request POST 'https://api.apyhub.com/generate/video-thumbnail/file?output=test-sample.mp4' \
2
--header 'apy-token: {{token}}' \
3
--form 'video=@"sample.mp4"'
4
--form 'start_time="0"'
5
--form 'duration="2"'
6
--form 'size="400x300"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe name of the output file, defaults to test-sample.mp4
Request Body
AttributeTypeMandatoryDescription
videoStringYesthe source video file in any of supported formats (mp4,webm,flv,avi,mkv,mov,3gp)
start_timeStringNothe time in seconds at which you want to generate the thumbnail. For example: if a video is 3 minutes long and you want to generate video thumbnail from 90th second then this will be as start_time: 90 and it defaults to 0 (generate video thumbnail from 0th second of the video)
durationStringNothe thumbnail length. For example: you want to generate the video thumbnail for 4 seconds then it will be as duration: 4 and it defaults to 2 and max duration user can enter is 20(seconds)
sizeStringNothe dimensions of the generated video file, should be in WidthxHeight format and it defaults to original_size
Sample Response
A successful request returns the mp4 file in the output parameter specified. If the request fails, the response contains an error code and a message to help determine what went wrong.

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
400Invalid input - the file is corrupt or the supported inputs are not provided.
401Required authentication information is either missing or not valid for the resource.
500If any unexpected error occurs while processing the request.

Authentication

All requests to ApyHub services need to be authenticated, currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
"error": {
3
"code": 105,
4
"message": "Invalid URL"
5
}
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.