Preview

projects.watermark.preview(, ) -> WatermarkPreviewResponse

POST/projects/{projectId}/watermark/preview

Draw the given watermark settings on a sample image, without saving them

ParametersExpand Collapse

project_id: str

opacity: Optional[float]

Mark opacity, 0.05 (barely visible) to 1 (opaque)

maximum1

minimum0.05

placement: Optional[Literal["bottom-left", "bottom-right", "center", 3 more]]

Where the mark sits on the image

One of the following:

"bottom-left"

"bottom-right"

"center"

"tiled"

"top-left"

"top-right"

rotation: Optional[float]

Mark rotation in degrees. 0 is horizontal, negative tilts it up.

maximum90

minimum-90

scale: Optional[float]

Mark width as a fraction of the image width

maximum1

minimum0.05

spacing: Optional[float]

Gap between repetitions, as a fraction of the mark’s own size. Only drawn for the tiled placement; 0 repeats the mark edge to edge.

maximum2

minimum0

text: Optional[str]

Text to draw. Optional only because a logo can stand in for it.

maxLength64

minLength1

ReturnsExpand Collapse

class WatermarkPreviewResponse: …

Response of the watermark preview routes.

image: str

The sample image with the mark drawn on it, base64-encoded.

Preview

import os
from scenario_sdk import Scenario

client = Scenario(
    api_key=os.environ.get("SCENARIO_SDK_API_KEY"),  # This is the default and can be omitted
    api_secret=os.environ.get("SCENARIO_SDK_API_SECRET"),  # This is the default and can be omitted
)
response = client.projects.watermark.preview(
    project_id="projectId",
)
print(response.image)

{
  "image": "image"
}

Returns Examples

{
  "image": "image"
}