Create session watermark template | Frame.io API Documentation

from frameio_experimental import FrameioExperimental, SessionWatermarkBlock, SessionWatermarkDataPoint
from frameio_experimental.session_watermark_templates import CreateSessionWatermarkTemplateParamsData
client = FrameioExperimental(
    token="YOUR_TOKEN_HERE",
)
client.session_watermark_templates.create(
    account_id="565df08e-cdda-421e-906e-40ac149eea75",
    data=CreateSessionWatermarkTemplateParamsData(
        name="ABC Watermark",
        watermark_blocks=[
            SessionWatermarkBlock(
                alpha=0.5,
                data_points=[
                    SessionWatermarkDataPoint(
                        order=0,
                        type="email",
                    ),
                    SessionWatermarkDataPoint(
                        order=1,
                        type="ip_address",
                    ),
                    SessionWatermarkDataPoint(
                        order=2,
                        type="timestamp",
                    )
                ],
                font_size="medium",
                name="viewer-identity",
                position="bottom_center",
                rotation=0,
                scroll_text="rtl",
                text_alignment="center",
                text_color="#FFFFFF",
                text_shadow=True,
            )
        ],
    ),
)

{
  "data": {
    "created_at": "2026-08-18T21:34:58.501275Z",
    "creator_id": "781d994f-390d-4f42-8d07-ef4ddd24215e",
    "deleted_at": null,
    "id": "6f1c9b2e-4c3a-4a1e-9b2e-0a1b2c3d4e5f",
    "name": "ABC Watermark",
    "updated_at": "2026-08-18T21:34:58.501275Z",
    "watermark_blocks": [
      {
        "data_points": [
          {
            "order": 0,
            "type": "email",
            "value": null
          },
          {
            "order": 1,
            "type": "ip_address",
            "value": null
          },
          {
            "order": 2,
            "type": "timestamp",
            "value": null
          }
        ],
        "alpha": 0.5,
        "font_size": "medium",
        "name": "viewer-identity",
        "position": "bottom_center",
        "position_reference_point": null,
        "position_x": null,
        "position_y": null,
        "rotation": 0,
        "scroll_text": "rtl",
        "text_alignment": "center",
        "text_color": "#FFFFFF",
        "text_shadow": true
      }
    ]
  }
}

Create a session watermark template owned by an account.
Rate Limits: 10 calls per 1.00 minute(s) per account_user

인증

AuthorizationBearer

Bearer <token> 형식의 Bearer 인증. 여기서 token은 인증 토큰입니다.

경로 매개변수

account_idstring필수

A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with adobe: (e.g. adobe:<adobe_org_id> for an account, adobe:<adobe_asset_id> for a project or folder, adobe:adobe:<adobe_asset_id>|<version>` for a file asset).

A Frame.io or Adobe entity identifier. Typically a Frame.io UUID. But for accounts, projects, folders, files, and version stacks that reside in Adobe cloud storage, which is the case for Workfront-connected accounts and projects, an Adobe-assigned id may also be used interchangeably. These ids must be prefixed with `adobe:` (e.g. `adobe:<adobe_org_id>` for an account, `adobe:<adobe_asset_id>` for a project or folder, `adobe:`adobe:<adobe_asset_id>|<version>` for a file asset).

요청

Session watermark template params body

dataobject필수

응답 헤더

x-ratelimit-limitinteger

Rate limit

x-ratelimit-remaininginteger

Rate limit remaining

x-ratelimit-windowinteger

Rate limit window in milliseconds

응답

Created

dataobject

A reusable configuration for a dynamic, per-viewer overlay painted onto streamed media.

오류

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

422

Unprocessable Entity Error

429

Too Many Requests Error