Eranol LogoEranol
BlogCommunityDocumentationPricingSign In

General

OverviewGet Started

Universal

Add IntroAdd OutroAudio to VideoBackground AudioCaptions ApiComposeConcatConvert a video file to MP4Convert Audio to Mp3Convert Audio to wavConvert to JPGConvert to WebMConvert to WebPDenoiseExtract audio track from a videoExtract images from a videoGenerate a GIF from a videoHighlightsImageMergeNotifyOverlayProgress BarReframeRemove SilenceThumbnailTikTokTrimVerifyWatermarkZoom

General

DeleteImage StatusStatusTikTok StatusFFmpeg Results

Need help?

Contact Support

Thumbnail

POST

Generate a thumbnail from a video frame with text overlay. Extracts the frame at the given timestamp and uses drawtext to render text with a background box. Example: {"url": "https://cdn.example.com/video.mp4", "text": "Episode 1", "timestamp": 5.0, "position": "center"}

Guide

Overview

Generate a thumbnail from a video frame with text overlay.

Extracts the frame at the given timestamp and uses drawtext to render text with a background box.

Example: {"url": "https://cdn.example.com/video.mp4", "text": "Episode 1", "timestamp": 5.0, "position": "center"}

Example Request Body

{
  "url": "https://cdn.example.com/video.mp4",
  "text": "Episode 1",
  "bg_color": "black@0.5",
  "position": "center",
  "font_size": 48,
  "timestamp": 5,
  "font_color": "white"
}

Example Response

{
  "job_id": "f595b9ad-1e15-4452-b7c2-8f8ff09c0a34",
  "status": "pending",
  "message": "Job created. Poll status_url for progress.",
  "job_type": "caption",
  "result_url": "https://eranol.com/api/v1/ffmpeg/result/f595b9ad-1e15-4452-b7c2-8f8ff09c0a34",
  "status_url": "https://eranol.com/api/v1/ffmpeg/status/f595b9ad-1e15-4452-b7c2-8f8ff09c0a34"
}

Endpoint

Send your requests to the following URL using the specified HTTP method.

POST https://eranol.com/api/v1/ffmpeg/video/thumbnail

Headers

Include the following headers with every request. Your API key is required for authentication.

Content-Type:application/json
x-api-key:YOUR_API_KEY

Request Body

Send the following JSON payload in the request body. Adjust the values to match your use case.

json
{
  "url": "https://cdn.example.com/video.mp4",
  "text": "Episode 1",
  "bg_color": "black@0.5",
  "position": "center",
  "font_size": 48,
  "timestamp": 5,
  "font_color": "white"
}

Parameters

All available options for this endpoint. Required parameters are marked accordingly.

ParameterTypeDefaultDescription
urlstringrequiredVideo file URL
time_secfloat0Time in seconds to capture the frame
widthint1280Thumbnail width in pixels
heightint720Thumbnail height in pixels
textstringnullOptional text to overlay on the thumbnail
font_sizeint48Font size for overlay text
font_colorstringwhiteFont color for overlay text

Example Request

Use the following cURL command to make a request to this API endpoint. Replace YOUR_API_KEY with your actual API key from the dashboard.

bash
curl -X POST "https://eranol.com/api/v1/ffmpeg/video/thumbnail" \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://cdn.example.com/video.mp4","text":"Episode 1","bg_color":"black@0.5","position":"center","font_size":48,"timestamp":5,"font_color":"white"}'

Example Response

Below is an example of a successful JSON response from this endpoint.

json
{
  "job_id": "f595b9ad-1e15-4452-b7c2-8f8ff09c0a34",
  "status": "pending",
  "message": "Job created. Poll status_url for progress.",
  "job_type": "caption",
  "result_url": "https://eranol.com/api/v1/ffmpeg/result/f595b9ad-1e15-4452-b7c2-8f8ff09c0a34",
  "status_url": "https://eranol.com/api/v1/ffmpeg/status/f595b9ad-1e15-4452-b7c2-8f8ff09c0a34"
}

Response Status

A successful request will return one of the following HTTP status codes.

200 OKRequest was successful and data is returned in the response body.
201 CreatedResource was successfully created.
401 UnauthorizedMissing or invalid API key.
429 Too Many RequestsRate limit exceeded. Try again later.