Generate Video Thumbnail Job API - ApyHub

Generate Video Thumbnail Job API

File Conversion#job#thumbnail#video
job
ApyHub
ApyHub
verified icon
400 atoms

About

The Generate Video Thumbnail Job API lets you automatically produce thumbnails from any video file, URL, or supported platform like YouTube or Dailymotion through an asynchronous job approach. Submit a job with your desired video source and thumbnail parameters, then periodically check the job’s status. Once the job completes, retrieve your thumbnail image files directly from the API.
This Job API can help content creators, marketers, and editors to produce high-quality thumbnails without getting tied up in synchronous processing. You can generate engaging previews at scale, streamline your editing workflow, and always ensure you have captivating thumbnails for your content.
Try the Video Thumbnail Job API in the API playground and discover how easy it is to enhance your content production pipeline with a simple, background-based thumbnail generation process.
Apy Jobs are long running calls which are split into two actions:
1. Submitting the job
2. Checking the status of the job and receiving the response on successful completion of the job.
Select API Endpoints
Input(s)

API Playground

API Documentation

Generate Video Thumbnail Submit Job : input file
POST
https://api.apyhub.com/job/generate/video-thumbnail/file

Request example

1
curl --location --request POST 'https://api.apyhub.com/job/generate/video-thumbnail/file' \
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
persistentBooleanNoSet to true to retain the converted video URL indefinitely. If false, the URL expires after 15 minutes, default false.
Request Body
AttributeTypeMandatoryDescription
videoFileYesThe 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 where Width and Height must be divisible by 2 and it defaults to original_size
Response
AttributeTypeDescription
job_idStringThe ID of the Job associated with the input video file, which can be utilized by the "Check Status" endpoint to retrieve the video thumbnail.
Sample Response
1
{
2
    "job_id": "4f3dfb22-33df-49f6-9820-7d8219ab6dc4"
3
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
200The request was successful.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - the provided files are corrupt or the supported inputs are not provided.
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