Video to Image Thumbnail Generator API - ApyHub - ApyHub

Generate Thumbnail from Video API

File Conversion#image#thumbnail#video
ApyHub
ApyHub
verified icon
550 atoms

About

This API generates image thumbnails from any input video file, in the desired size (pixels). The API supports multiple video formats including MP4, WEBM, FLV, AVI, MKV, MOV and 3GP.
Ideal for applications that require quick and efficient extraction of thumbnails from video files for previews, galleries, or video editing.
Try out the Video Thumbnail API in the API playground for free, improve your workflow, and reduce video thumbnail generation errors with a simple API call.
Tip: For large-size video files , it’s recommended to use the corresponding JOB API to ensure optimal performance and prevent timeouts.
Select API Endpoints
Input
Output

API Playground

API Documentation

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

Request example

1
curl --location --request POST 'https://api.apyhub.com/generate/image-thumbnail/file?output=test-sample.png' \
2
--header 'apy-token: {{token}}' \
3
--form 'video=@"sample.mp4"'
4
--form 'time="1"'
5
--form 'size="400x300"'
Method: POST
Content Type: multipart/form-data
Query Parameter(s)
AttributeTypeMandatoryDescription
outputStringNoThe name of the output file, defaults to test-sample.png.
Request Body
AttributeTypeMandatoryDescription
videoFileYesThe source video file in any of supported formats (mp4,webm,flv,avi,mkv,mov,3gp).
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 thumbnail at 90th second then this will be as time: 90 and it defaults to 1 (generate thumbnail at 1st second of the video).
sizeStringNoThe dimensions of the generated image file, should be in WidthxHeight format and it defaults to original_size.
Sample Response
A successful request returns the image 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 video 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 API 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 your workspace settings (on the left side of the navbar) and go to “API Keys".
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.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles