Set the project's encoding watermark image
Set the project's encoding watermark image
/v1/projects/{id}/encoding-settings/watermark-imageThis operation supports dashboard session-cookie authentication. Call it only from trusted server code; browsers must not manufacture or expose the session cookie.
Uploads the PNG or WebP overlay the encoder burns into future
renditions. The request body is the raw image bytes (at most 5 MB) and
the Content-Type header must match the payload's actual format
(image/png or image/webp). The upload stores the object, sets
watermark.imageKey to the stored key, sets watermark.enabled to
true, and deletes the previously stored image. The response carries
id, the resulting watermark object, and updatedAt. Session-cookie
auth only. Rate limit: 20 requests per 60 s per session.
Error codes: unauthorized (401), not_found (404), invalid_body
(400 — empty body), invalid_image (400 — the bytes are not PNG/WebP
or do not match the declared Content-Type).
Authentication
- sessionCookie — Dashboard session cookie set by
POST /v1/auth/login. Video and playback endpoints additionally require theprojectIdquery parameter under cookie auth.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string (Ulid) | Yes | — |
Request body
required
Content type: image/png
Content type: image/webp
Responses
| Status | Meaning |
|---|---|
200 | The watermark object after the upload. |
400 | The request body or query failed validation. The per-operation description lists the exact error.code values. |
401 | No valid credential was presented. |
404 | The resource does not exist or is not visible to this caller. |
429 | Rate limit exceeded. |