API ReferenceWatermark

Apply watermark

Apply a Perth v2 watermark to an audio, image, or video file. The media type is automatically detected from the file content. Processing is asynchronous unless the Prefer: wait header is supplied.

Authentication

AuthorizationBearer
API key from https://app.resemble.ai/hub/api

Headers

PreferenumOptional
When set to "wait", the API processes synchronously and returns the completed result.
Allowed values:

Request

This endpoint expects an object.
urlstringRequiredformat: "uri"
Public HTTPS URL to the audio, image, or video source.
output_formatenumOptionalDefaults to default

default returns WAV (audio), PNG (image), or MP4 (video). source returns the source’s format (for example JPEG, AVIF, M4A, or MOV) when it can be reproduced, otherwise the default.

Allowed values:
strengthdoubleOptional0-1Defaults to 0.2

Watermark strength for image/video. Ignored for audio.

custom_messagestringOptional<=64 charactersDefaults to resembleai

Message to embed in image/video. Ignored for audio.

Response

Watermark job created
successboolean
itemobject