Detect Watermark

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

Detect a watermark in an audio file using the provided URL.

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

Request Parameters

Example

$
curl --request POST 'https://app.resemble.ai/api/v2/watermark/detect' \
>
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
>
  -H 'Content-Type: application/json' \
>
  --data '{
>
    "url": "https://example.com/audio/suspect.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
}

Fetch Watermark Detection Result

Retrieve the result of a detected watermark using the provided UUID.

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

Example

$
curl --request GET 'https://app.resemble.ai/api/v2/watermark/detect/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
    "metrics": {
6
      "detected": true,
7
      "confidence": 0.95,
8
      "watermark_data": {}
9
    },
10
    "watermarked_audio": null,
11
    "created_at": "2024-01-01T00:00:00.000Z",
12
    "updated_at": "2024-01-01T00:00:00.000Z"
13
  }
14
}

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.