Preview

POST/projects/{projectId}/watermark/preview

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

Path ParametersExpand Collapse

projectId: string

Body ParametersJSONExpand Collapse

opacity: optional number

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

maximum1

minimum0.05

placement: optional "bottom-left" or "bottom-right" or "center" or 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 number

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

maximum90

minimum-90

scale: optional number

Mark width as a fraction of the image width

maximum1

minimum0.05

spacing: optional number

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 string

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

maxLength64

minLength1

ReturnsExpand Collapse

image: string

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

Preview

curl https://api.cloud.scenario.com/v1/projects/$PROJECT_ID/watermark/preview \
    -H 'Content-Type: application/json' \
    -u "$SCENARIO_SDK_API_KEY:SCENARIO_SDK_API_SECRET" \
    -d '{}'

{
  "image": "image"
}

Returns Examples

{
  "image": "image"
}