Watermark

Delete

DELETE/projects/{projectId}/watermark

Delete Logo

DELETE/projects/{projectId}/watermark/logo

Preview

POST/projects/{projectId}/watermark/preview

Retrieve

GET/projects/{projectId}/watermark

Update

PUT/projects/{projectId}/watermark

Update Logo

PUT/projects/{projectId}/watermark/logo

ModelsExpand Collapse

WatermarkDeleteResponse object { deleted }

deleted: boolean

WatermarkDeleteLogoResponse object { watermark }

watermark: object { id, createdAt, createdBy, 14 more }

Forced-watermark configuration stored at one scope.

id: string

Stable identifier derived from level + scopeId

createdAt: string

ISO-8601 creation timestamp

createdBy: string

User id that last wrote the configuration

enabled: boolean

Whether the watermark is enforced on assets generated in this scope. A disabled project configuration falls back to its team’s.

level: "project" or "team"

Scope this configuration applies to: team or project

One of the following:

"project"

"team"

opacity: number

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

placement: "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: number

Mark rotation in degrees, -90 to 90. 0 is horizontal.

scale: number

Mark width as a fraction of the image width

scopeId: string

The id of the team or project that owns this configuration

spacing: number

Gap between repetitions, as a fraction of the mark’s own size. Tiled placement only; 0 repeats the mark edge to edge.

updatedAt: string

ISO-8601 last-update timestamp

version: number

Bumped on every write.

deletedAt: optional string

Set when the configuration has been deleted.

logoIsOpaque: optional boolean

Whether the stored logo has no transparency at all.

Recorded at upload so the UI can warn without decoding the image again: an opaque logo draws its whole rectangle, which a rotated tiled mark turns into a very visible diamond.

logoKey: optional string

Where the uploaded logo lives, when one is set.

text: optional string

Text rendered as the mark, when no logo is set

WatermarkPreviewResponse object { image }

Response of the watermark preview routes.

image: string

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

WatermarkRetrieveResponse object { watermark }

watermark: object { id, createdAt, createdBy, 14 more }

Forced-watermark configuration stored at one scope.

id: string

Stable identifier derived from level + scopeId

createdAt: string

ISO-8601 creation timestamp

createdBy: string

User id that last wrote the configuration

enabled: boolean

Whether the watermark is enforced on assets generated in this scope. A disabled project configuration falls back to its team’s.

level: "project" or "team"

Scope this configuration applies to: team or project

One of the following:

"project"

"team"

opacity: number

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

placement: "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: number

Mark rotation in degrees, -90 to 90. 0 is horizontal.

scale: number

Mark width as a fraction of the image width

scopeId: string

The id of the team or project that owns this configuration

spacing: number

Gap between repetitions, as a fraction of the mark’s own size. Tiled placement only; 0 repeats the mark edge to edge.

updatedAt: string

ISO-8601 last-update timestamp

version: number

Bumped on every write.

deletedAt: optional string

Set when the configuration has been deleted.

logoIsOpaque: optional boolean

Whether the stored logo has no transparency at all.

Recorded at upload so the UI can warn without decoding the image again: an opaque logo draws its whole rectangle, which a rotated tiled mark turns into a very visible diamond.

logoKey: optional string

Where the uploaded logo lives, when one is set.

text: optional string

Text rendered as the mark, when no logo is set

WatermarkUpdateResponse object { watermark }

watermark: object { id, createdAt, createdBy, 14 more }

Forced-watermark configuration stored at one scope.

id: string

Stable identifier derived from level + scopeId

createdAt: string

ISO-8601 creation timestamp

createdBy: string

User id that last wrote the configuration

enabled: boolean

Whether the watermark is enforced on assets generated in this scope. A disabled project configuration falls back to its team’s.

level: "project" or "team"

Scope this configuration applies to: team or project

One of the following:

"project"

"team"

opacity: number

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

placement: "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: number

Mark rotation in degrees, -90 to 90. 0 is horizontal.

scale: number

Mark width as a fraction of the image width

scopeId: string

The id of the team or project that owns this configuration

spacing: number

Gap between repetitions, as a fraction of the mark’s own size. Tiled placement only; 0 repeats the mark edge to edge.

updatedAt: string

ISO-8601 last-update timestamp

version: number

Bumped on every write.

deletedAt: optional string

Set when the configuration has been deleted.

logoIsOpaque: optional boolean

Whether the stored logo has no transparency at all.

Recorded at upload so the UI can warn without decoding the image again: an opaque logo draws its whole rectangle, which a rotated tiled mark turns into a very visible diamond.

logoKey: optional string

Where the uploaded logo lives, when one is set.

text: optional string

Text rendered as the mark, when no logo is set

WatermarkUpdateLogoResponse object { watermark }

watermark: object { id, createdAt, createdBy, 14 more }

Forced-watermark configuration stored at one scope.

id: string

Stable identifier derived from level + scopeId

createdAt: string

ISO-8601 creation timestamp

createdBy: string

User id that last wrote the configuration

enabled: boolean

Whether the watermark is enforced on assets generated in this scope. A disabled project configuration falls back to its team’s.

level: "project" or "team"

Scope this configuration applies to: team or project

One of the following:

"project"

"team"

opacity: number

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

placement: "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: number

Mark rotation in degrees, -90 to 90. 0 is horizontal.

scale: number

Mark width as a fraction of the image width

scopeId: string

The id of the team or project that owns this configuration

spacing: number

Gap between repetitions, as a fraction of the mark’s own size. Tiled placement only; 0 repeats the mark edge to edge.

updatedAt: string

ISO-8601 last-update timestamp

version: number

Bumped on every write.

deletedAt: optional string

Set when the configuration has been deleted.

logoIsOpaque: optional boolean

Whether the stored logo has no transparency at all.

Recorded at upload so the UI can warn without decoding the image again: an opaque logo draws its whole rectangle, which a rotated tiled mark turns into a very visible diamond.

logoKey: optional string

Where the uploaded logo lives, when one is set.

text: optional string

Text rendered as the mark, when no logo is set