Three ways to use this tool

REST API

One POST request. Get the result back directly — as an image, video, or JSON depending on the tool.

terminal

curl -X POST https://apiai.me/api/workflow/banner-on-video \
     -H "X-API-Key: YOUR_API_KEY" \
     -F "color_scheme=coral" \
     -F "crf=23" \
     -F "end_time=0" \
     -F "fade_in=0" \
     -F "fade_out=0" \
     -F "font_size=auto" \
     -F "headline=VALUE" \
     -F "margin=30" \
     -F "opacity=1.0" \
     -F "position=bottom-left" \
     -F "preset=medium" \
     -F "rotation=0" \
     -F "start_time=0" \
     -F "style=ribbon" \
     -F "subline=VALUE" \
     -F "text_padding=10"
     --output result.png

Dashboard Playground

Test this tool visually before writing any code. Upload an image, set parameters, and see the result live. When it looks right, copy the auto-generated curl command and paste it into your app.

Open the dashboard → API Toolbox
Find Banner on video and click it
Upload your input and adjust parameters
Copy the curl command and ship

Open Dashboard →

Batch Processing

Process hundreds of images at once without writing a loop. Upload a CSV with one row per item, set your parameters, and download the results as a ZIP when they're done.

Open the dashboard → Batches
Select Banner on video
Add your content and start the batch
Download results ZIP when complete

Go to Batches →

Parameters

Name	Required	Description	Default / Options
`color_scheme`	optional	Colour palette: coral, midnight, lime, gold, pink, mono, sky	`coralmidnightlimegoldpinkmonosky`
`crf`	optional	Video quality 0-51: lower = better quality but larger file	`23`
`end_time`	optional	When to hide the badge, in seconds (0 = visible until end)	`0`
`fade_in`	optional	Seconds to fade the badge in (0 = instant appear)	`0`
`fade_out`	optional	Seconds to fade the badge out (0 = instant disappear)	`0`
`font_size`	optional	Headline font size in pixels, or auto to scale with video	`auto`
`headline`	required	Main promotional text, e.g. Summer Sale, Just In!, New Arrival	—
`margin`	optional	Gap from nearest edges in pixels	`30`
`opacity`	optional	Overall overlay opacity 0.0 (invisible) to 1.0 (fully opaque)	`1.0`
`position`	optional	Where to place the badge on the video	`top-lefttop-centertop-rightcenter-leftcenter-centercenter-rightbottom-leftbottom-centerbottom-right`
`preset`	optional	Encoding speed tradeoff: faster = quicker encode but larger file	`ultrafastsuperfastveryfastfasterfastmediumslowslowerveryslow`
`rotation`	optional	Badge rotation in degrees (positive = clockwise)	`0`
`start_time`	optional	When to show the badge, in seconds from start (0 = always visible)	`0`
`style`	optional	Visual treatment: ribbon, badge, sticker, pill, banner, tag	`ribbonbadgestickerpillbannertag`
`subline`	optional	Optional smaller second line, e.g. Up to 50% off	—
`text_padding`	optional	Extra inner padding in pixels between the text and the badge edges	`10`

Banner on videoAPI

Three ways to use this tool

REST API

Dashboard Playground

Batch Processing

Parameters

Ready to integrate?