resemble-ai/watermark | API reference

resemble-ai / watermark

Watermarks audio files with neurally generated watermark.

Public
563.9K runs
Paper

Run resemble-ai/watermark with an API

Use one of our client libraries to get started quickly. Clicking on a library will take you to the Playground tab where you can tweak different inputs, see the results, and copy the corresponding code to use in your own project.

Input schema

The fields you can use to run this model with an API. If you don't give a value for a field its default value will be used.

Field	Type	Default value	Description
content	string		audio file to be watermarked
mode	string (enum)	Options: apply, detect	Mode of Operation: Apply a Watermark to file, or Detect if the file has a watermark
callback_url	string		(Optional) Callback URL to send results to.
qr_code	string		URL or information to encode into video stream. Unused if encoding just audio.
warm	boolean	False	Warm the model up before running inference.

{
  "type": "object",
  "title": "Input",
  "required": [
    "content",
    "mode"
  ],
  "properties": {
    "mode": {
      "enum": [
        "apply",
        "detect"
      ],
      "type": "string",
      "title": "mode",
      "description": "Mode of Operation: Apply a Watermark to file, or Detect if the file has a watermark",
      "x-order": 1
    },
    "warm": {
      "type": "boolean",
      "title": "Warm",
      "default": false,
      "x-order": 4,
      "description": "Warm the model up before running inference. "
    },
    "content": {
      "type": "string",
      "title": "Content",
      "format": "uri",
      "x-order": 0,
      "description": "audio file to be watermarked"
    },
    "qr_code": {
      "type": "string",
      "title": "Qr Code",
      "x-order": 3,
      "description": "URL or information to encode into video stream. Unused if encoding just audio."
    },
    "callback_url": {
      "type": "string",
      "title": "Callback Url",
      "x-order": 2,
      "description": "(Optional) Callback URL to send results to."
    }
  }
}

Output schema

The shape of the response you’ll get when you run this model with an API.

Schema

{
  "anyOf": [
    {
      "type": "object",
      "title": "WatermarkerResponse",
      "properties": {
        "has_watermark": {
          "type": "object",
          "title": "Has Watermark",
          "additionalProperties": {
            "type": "boolean"
          }
        },
        "watermarked_content": {
          "type": "string",
          "title": "Watermarked Content",
          "format": "uri"
        }
      }
    },
    {
      "type": "string"
    }
  ],
  "title": "Output"
}