Skip to main content
POST
Run a media tool against a stored file

Authorizations

Authorization
string
header
required

Dashboard-generated Convertly API key. Keys currently begin with cvly_.

Path Parameters

id
string<uuid>
required

Body

application/json
tool
enum<string>
required

Which Media Tools operation to run against the stored file.

Available options:
remove-background,
transform,
vectorize,
watermark,
adjust,
trim,
convert,
extract-audio,
gif,
poster-frame,
storyboard
params
object

Tool-specific parameters. Send the same fields you would send as form data to the equivalent /api/media/* route, as a JSON object of string values.

preview
boolean
default:false

When true, returns a base64 data URL in the response without writing a new stored file. Useful for in-app previews.

watermarkLogoDataUrl
string

Watermark only. A data: URL containing the logo image. Required for tool=watermark with a logo input.

Response

New stored file (or preview when preview=true)

file
object
required