API Parameters

These parameters are supported by both the endpoints.

• The Main Image
  The base image to watermark. It is required. Provide using exactly one of these parameters:

  • image: For the main image as a file. Type: File
  • image_url: For the publicly accessible URL of the main image. Type: String (Valid URL of the image)
  • image_datastring: For the DataURL representation of the main image. Type: String (DataURL of the image)
  • image_base64: For Base64-encoded main image data. Type: String (Base64 code of the image)

  The priority is as follows:
  image > image_url > image_datastring > image_base64

• opacity
  The opacity (transparency) of the watermark.
  Type: Float Range: Between 0 and 1 (0 means transparent, 1 is opaque)
• position
  The position of the watermark. Only works if x and y are not set.
  Type: String Values: top-left | top-center | top-right | middle-left | center | middle-right | bottom-left | bottom-center | bottom-right Default: center
• x
  The X coordinate of the watermark for positioning, relative to the image. It overrides the value of position.
  Type: Integer
• y
  The Y coordinate of the watermark for positioning, relative to the image. It overrides the value of position.
  Type: Integer
• margin
  The distance from the edge of the image to the watermark text/image. It is relative to the image size.
  Type: Integer Default: 10
• rotation_angle
  Rotate the watermark. It is in degrees.
  Type: Integer Range: Between 0 and 360
• repeat
  Whether to repeat the watermark or not.
  Type: Boolean Default: false
• repeat_spacing
  The horizontal spacing between repeating watermarks. It is relative to the image size.
  Type: Integer
• vertical_spacing
  The vertical spacing between repeating watermarks. It is also relative to the image size.
  Type: Integer
• target_format
  File format of the output image.
  Type: String Values: JPEG | PNG | WebP | TIFF | GIF | HEIC | HEIF Default: JPEG
• target_type
  Determines how the output image should be delivered.
  Type: String Values: base64 | file | dataurl Default: base64
• retain_exif
  Whether to retain the EXIF metadata or not.
  Type: Boolean Default: false

These parameters are only supported by the text-on-image endpoint. (POST /watermark/text) They are used to apply styles to the text that will be applied as watermark.

• watermark_text
  The text which will be applied as watermark. It is required.
  Type: String
• text_font_family
  The Google Fonts slug of the font.

  Learn How to get the correct font-family from Google Fonts?

  Type: String Values: The Google Fonts slug of any font. Default: Roboto
• text_color
  The color of the text.
  Type: String (color like #00C1FF, blue, rgb(0, 0, 255)) Default: white
• text_font_size
  The size of the text in px. It is relative to the image size.
  Type: Integer Default: 30
• text_background
  The background color of the text.
  Type: String (color like #00C1FF, blue, rgb(0, 0, 255)) Default: transparent
• text_font_weight
  The thickness of the font.
  Type: String Values: Could be regular, bold, thin, light etc. as depends on the font. Default: regular
• text_font_style
  Whether the text should be italic or normal.
  Type: String Values: normal | italic Default: normal
• padding
  Internal padding of the text box.
  Type: Integer Default: 10

These parameters are only applicable for the image-on-image endpoint. (POST /watermark/image) These parameters can customize the placement of the logo image:

• The watermark image
  The watermark image (logo image) to watermark. It is required for the image-on-image watermark endpoint. Provide the watermark logo by any one of the following parameters:

  • watermark_image: For the logo image as a file. Type: File
  • watermark_url: For the publicly accessible URL of the logo image. Type: String (Valid URL of the image)
  • watermark_datastring: For the DataURL representation of the logo image. Type: String (DataURL of the image)
  • watermark_base64: For Base64-encoded logo image data. Type: String (Base64 code of the image)

  The priority is as follows:
  watermark_image > watermark_url > watermark_datastring > watermark_base64

• watermark_scale
  Scale factor relative to the shorter side of the base image to ensure the watermark always fits.
  Type: Float (any positive float) Default: 0.4