Apply Watermark

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

Apply a watermark to an audio file using the provided URL.

POST https://app.resemble.ai/api/v2/watermark/apply

Request Parameters

FieldTypeRequiredDescription
urlstringHTTPS URL to audio file (must be valid media format).
qr_codestringQR code URL prefix (watermark UUID will be appended).

Example

$curl --request POST 'https://app.resemble.ai/api/v2/watermark/apply' \
> -H 'Authorization: Bearer YOUR_API_TOKEN' \
> -H 'Content-Type: application/json' \
> --data '{
> "url": "https://example.com/audio/source.wav"
> }'

Response

1{
2 "success": true,
3 "item": {
4 "uuid": "JOB_UUID",
5 "metrics": null,
6 "watermarked_audio": null,
7 "created_at": "2024-01-01T00:00:00.000Z",
8 "updated_at": "2024-01-01T00:00:00.000Z"
9 }
10}

URL must be HTTPS and point to a valid media file. Processing is asynchronous.

Fetch Apply Result

Retrieve the result of an applied watermark using the provided UUID.

GET https://app.resemble.ai/api/v2/watermark/apply/{uuid}/result

Example

$curl --request GET 'https://app.resemble.ai/api/v2/watermark/apply/JOB_UUID/result' \
> -H 'Authorization: Bearer YOUR_API_TOKEN' \
> -H 'Content-Type: application/json'

Response

1{
2 "success": true,
3 "item": {
4 "uuid": "JOB_UUID",
5 "created_at": "2024-01-01T00:00:00.000Z",
6 "updated_at": "2024-01-01T00:00:00.000Z",
7 "watermarked_audio": "https://app.resemble.ai/rails/active_storage/..."
8 }
9}

Response Fields

FieldTypeDescription
successbooleanIndicates whether the operation was successful
item.uuidstringUnique identifier for the watermark job
item.created_atstringTimestamp of when the job was created
item.updated_atstringTimestamp of when the job was last updated
item.watermarked_audiostringSigned URL to the watermarked audio file

Important: The signed watermarked_audio URL expires; download and store the asset promptly.

Error Handling

If the request is unsuccessful, you will receive an error response:

1{
2 "success": false,
3 "error": "Invalid audio file format. Please provide a WAV file."
4}

Ensure that you provide a valid URL, and that the audio file is in WAV format and accessible via HTTPS.