Watermarking

Beta: Watermark API is currently in beta. Please contact us if you would like to be added to the beta program.

The Resemble Watermark API allows you to apply and detect watermarks on audio, image, and video files. The media type is automatically detected from the file URL. These endpoints provide functionality to apply and detect watermarks, and you can access the results of these operations through dedicated result endpoints.

Supported Media Types

Media TypeSupported FormatsAdditional Parameters
AudioWAV, MP3, and other audio formats
ImagePNG, JPEG, and other image formatsstrength, custom_message
VideoMP4, MOV, and other video formatsstrength, custom_message

Synchronous Mode

By default, processing is asynchronous and you must poll the result endpoint. To receive the result in a single request, include the Prefer: wait header. The API will wait for processing to complete before returning the response.

1interface ApplyRequest {
2 url: string;
3 strength?: number; // Image/Video only (0.0-1.0, default: 0.2)
4 custom_message?: string; // Image/Video only (default: "resembleai")
5}
6
7interface ApplyResult {
8 success: boolean;
9 item: {
10 uuid: string;
11 media_type: "audio" | "image" | "video";
12 source_media_url: string;
13 watermarked_media: string | null;
14 metrics: object | null;
15 created_at: string;
16 updated_at: string;
17 };
18}
19
20interface DetectRequest {
21 url: string;
22 custom_message?: string; // Image/Video only (default: "resembleai")
23}
24
25interface DetectResult {
26 success: boolean;
27 item: {
28 uuid: string;
29 media_type: "audio" | "image" | "video";
30 source_media_url: string;
31 watermarked_media: string | null;
32 metrics: object | null;
33 created_at: string;
34 updated_at: string;
35 };
36}