> This page is for Plataforma, version V4 experimental. > For other versions, use one of these documentation indexes: > - V4 (default): https://developer.frame.io/platform/v4/llms.txt > - V4 experimental: https://developer.frame.io/platform/v4-experimental/llms.txt > - Herdado: https://developer.frame.io/platform/v2/llms.txt > For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://developer.frame.io/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://developer.frame.io/_mcp/server. # List session watermark templates GET https://api.frame.io/v4/accounts/{account_id}/session_watermark_templates List the session watermark templates owned by an account. Rate Limits: 100 calls per 1.00 minute(s) per account\_user Reference: https://developer.frame.io/platform/v4-experimental/api-reference/session-watermark-templates/index ## Authentication - `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer `, where token is your auth token. ## Request ### Path parameters - `account_id` (string, required) ### Query parameters - `include` (enum, optional) - Allowed values: `creator` - `sort` (enum, optional) — Sort session watermark templates by query params - Allowed values: `name_asc`, `created_at_asc`, `name_desc`, `created_at_desc` - `after` (string, optional) — Opaque Cursor query param for requests returning paginated results. NOTE: this value is auto-generated and included as part of links from a previous response. It is not intended to be human readable. - `page_size` (integer, optional, default: 50) - `include_total_count` (boolean, optional, default: false) ### Headers - `api-version` (enum, required) - Allowed values: `experimental` ## Response ### 200 OK - `data` (list of SessionWatermarkTemplateWithIncludes, required) — Session watermark templates - `links` (Links, required) — Links to paginated data - `total_count` (integer, optional, nullable) — Total count ## Errors ### 400 Bad Request Error Bad request - `errors` (list of BadRequestErrorsItems, required) ### 401 Unauthorized Error Unauthorized - `errors` (list of UnauthorizedErrorsItems, required) ### 403 Forbidden Error Forbidden - `errors` (list of ForbiddenErrorsItems, required) ### 404 Not Found Error Not found - `errors` (list of NotFoundErrorsItems, required) ### 409 Conflict Error Conflict - `errors` (list of ConflictErrorsItems, required) ### 422 Unprocessable Entity Error Unprocessable content - `errors` (list of UnprocessableContentErrorsItems, required) ### 429 Too Many Requests Error Too many requests - `errors` (list of TooManyRequestsErrorsItems, required) ## Types ### SessionWatermarkTemplateWithIncludes A reusable configuration for a dynamic, per-viewer overlay painted onto streamed media. - `created_at` (string, required) - `creator_id` (string, required, nullable) - `deleted_at` (string, required, nullable) - `id` (string, required) — Template ID. - `name` (string, required) — Template name. - `updated_at` (string, required) - `watermark_blocks` (list of SessionWatermarkBlock, required) - `creator` (User, optional) — User details ### Links Links to paginated data - `next` (string, required, nullable) — "Link to next page of data. This link is the request path with the addition of the `after` query parameter to fetch the next page of results. It only carries the `after` cursor. Other query params from the original request (e.g. `include`, `sort`, `page_size`, `include_total_count`, filters) are not preserved and must be re-added by the client on every subsequent request, including when following this link. ### BadRequestErrorsItems - `detail` (string, required) - `source` (BadRequestErrorsItemsSource, optional) - `title` (string, optional) ### UnauthorizedErrorsItems - `detail` (string, required) - `source` (UnauthorizedErrorsItemsSource, optional) - `title` (string, optional) ### ForbiddenErrorsItems - `detail` (string, required) - `source` (ForbiddenErrorsItemsSource, optional) - `title` (string, optional) ### NotFoundErrorsItems - `detail` (string, required) - `source` (NotFoundErrorsItemsSource, optional) - `title` (string, optional) ### ConflictErrorsItems - `detail` (string, required) - `source` (ConflictErrorsItemsSource, optional) - `title` (string, optional) ### UnprocessableContentErrorsItems - `detail` (string, required) - `source` (UnprocessableContentErrorsItemsSource, optional) - `title` (string, optional) ### TooManyRequestsErrorsItems - `detail` (string, required) - `source` (TooManyRequestsErrorsItemsSource, optional) - `title` (string, optional) ### SessionWatermarkBlock One positioned chunk of text drawn on the video, plus its formatting and content. - `data_points` (list of SessionWatermarkDataPoint, required) — The ordered lines of text. - `alpha` (double, optional) — Opacity from >0 to 1. - `font_size` (enum, optional) — Relative font size. - Allowed values: `small`, `medium`, `large`, `huge` - `name` (string, optional, nullable) — Human label for the block - `position` (enum, optional) — Named 9-grid slot. - Allowed values: `top_left`, `top_right`, `bottom_left`, `bottom_right`, `top_center`, `bottom_center`, `middle_left`, `middle_center`, `middle_right` - `position_reference_point` (enum, optional, nullable) — Anchor the free-form coordinates are measured from. - Allowed values: `top_left`, `top_right`, `bottom_left`, `bottom_right`, `top_center`, `bottom_center`, `middle_left`, `middle_center`, `middle_right` - `position_x` (double, optional, nullable) — Free-form X (0-1); overrides `position` when set. - `position_y` (double, optional, nullable) — Free-form Y (0-1); overrides `position` when set. - `rotation` (double, optional) — Rotation in degrees (-45.0 to 45.0). - `scroll_text` (enum, optional) — Scroll animation. - Allowed values: `none`, `rtl`, `ltr` - `text_alignment` (enum, optional) — Horizontal alignment. - Allowed values: `left`, `center`, `right` - `text_color` (string, optional) — Hex text color. - `text_shadow` (boolean, optional) — Draw a drop shadow behind the text. ### User User details - `active` (boolean, required, nullable) — User active status - `avatar_url` (string, required, nullable) — User avatar image url - `email` (string, required) — User email - `id` (string, required, nullable) — User ID - can be null for invited users with no Frame account - `name` (string, required, nullable) — User name - `adobe_user_id` (string, optional, nullable) — Adobe user ID ### BadRequestErrorsItemsSource - `pointer` (string, optional) ### UnauthorizedErrorsItemsSource - `pointer` (string, optional) ### ForbiddenErrorsItemsSource - `pointer` (string, optional) ### NotFoundErrorsItemsSource - `pointer` (string, optional) ### ConflictErrorsItemsSource - `pointer` (string, optional) ### UnprocessableContentErrorsItemsSource - `pointer` (string, optional) ### TooManyRequestsErrorsItemsSource - `pointer` (string, optional) ### SessionWatermarkDataPoint One ordered line of text rendered within a block. `type` is resolved per viewer at play time; `value` holds fixed text and is only meaningful when `type` is `custom_text`. - `order` (double, required, nullable) — Render order within the block. - `type` (enum, required) — The dynamic value rendered for this line. - Allowed values: `email`, `username`, `ip_address`, `timestamp`, `custom_text`, `user_input` - `value` (string, optional, nullable) — Fixed text; only set when `type` is `custom_text`. ## Examples **Response** ```json { "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 } ], "creator": { "active": true, "avatar_url": "https://assets.frame.io/uploads/cd58cb8e-24b3-4448-8d0f-9532fcd04d11/original.png?response-content-disposition=attachment%3B+filename%3D%22foo.png&Expires=1729857600&Signature=L09h0pi82dCrMYjr9lMHBragByWYh1&Key-Pair-Id=KKI497NESTHMN", "email": "user_email@example.com", "id": "c7649fb9-4c65-4c04-8778-b56c7ebd7423", "name": "Jon Doe", "adobe_user_id": "196C1A5666BF4EB00A49411B@176719f5667c82b4494214.e" } } ], "links": { "next": null }, "total_count": 1 } ``` **SDK Code** ```python import requests url = "https://api.frame.io/v4/accounts/9922f651-47d1-4153-bd2b-8fd980bb3b0c/session_watermark_templates" querystring = {"after":"","include":"creator","include_total_count":"false","page_size":"10","sort":"created_at_asc"} headers = { "api-version": "experimental", "Authorization": "Bearer " } response = requests.get(url, headers=headers, params=querystring) print(response.json()) ``` ```javascript const url = 'https://api.frame.io/v4/accounts/9922f651-47d1-4153-bd2b-8fd980bb3b0c/session_watermark_templates?after=%3Copaque_cursor%3E&include=creator&include_total_count=false&page_size=10&sort=created_at_asc'; const options = { method: 'GET', headers: {'api-version': 'experimental', Authorization: 'Bearer '} }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "net/http" "io" ) func main() { url := "https://api.frame.io/v4/accounts/9922f651-47d1-4153-bd2b-8fd980bb3b0c/session_watermark_templates?after=%3Copaque_cursor%3E&include=creator&include_total_count=false&page_size=10&sort=created_at_asc" req, _ := http.NewRequest("GET", url, nil) req.Header.Add("api-version", "experimental") req.Header.Add("Authorization", "Bearer ") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://api.frame.io/v4/accounts/9922f651-47d1-4153-bd2b-8fd980bb3b0c/session_watermark_templates?after=%3Copaque_cursor%3E&include=creator&include_total_count=false&page_size=10&sort=created_at_asc") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Get.new(url) request["api-version"] = 'experimental' request["Authorization"] = 'Bearer ' response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.get("https://api.frame.io/v4/accounts/9922f651-47d1-4153-bd2b-8fd980bb3b0c/session_watermark_templates?after=%3Copaque_cursor%3E&include=creator&include_total_count=false&page_size=10&sort=created_at_asc") .header("api-version", "experimental") .header("Authorization", "Bearer ") .asString(); ``` ```php request('GET', 'https://api.frame.io/v4/accounts/9922f651-47d1-4153-bd2b-8fd980bb3b0c/session_watermark_templates?after=%3Copaque_cursor%3E&include=creator&include_total_count=false&page_size=10&sort=created_at_asc', [ 'headers' => [ 'Authorization' => 'Bearer ', 'api-version' => 'experimental', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://api.frame.io/v4/accounts/9922f651-47d1-4153-bd2b-8fd980bb3b0c/session_watermark_templates?after=%3Copaque_cursor%3E&include=creator&include_total_count=false&page_size=10&sort=created_at_asc"); var request = new RestRequest(Method.GET); request.AddHeader("api-version", "experimental"); request.AddHeader("Authorization", "Bearer "); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "api-version": "experimental", "Authorization": "Bearer " ] let request = NSMutableURLRequest(url: NSURL(string: "https://api.frame.io/v4/accounts/9922f651-47d1-4153-bd2b-8fd980bb3b0c/session_watermark_templates?after=%3Copaque_cursor%3E&include=creator&include_total_count=false&page_size=10&sort=created_at_asc")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "GET" request.allHTTPHeaderFields = headers let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```