v1

latestOpenAPI 3.0.02026-07-26213850.5 KB
brand-templates
enterprise

get/api/brand-templates

Query parameters

q'mine' required

Response

templateIdstring required

Template ID

namestring required

Template name

isDefaultboolean required

Is default template

typestring

Type of template

Example response

[
  {
    "templateId": "cm32g2poc0002t5bnhmg2kfyx",
    "name": "Karaoke Template",
    "isDefault": true,
    "preferences": {
      "enableScreenLayout": true,
      "enableCrop": true,
      "enableCaption": true,
      "enableUppercase": true,
      "enableHighlight": true,
      "enableEmoji": true,
      "enableSplitLayout": true,
      "enableThreeLayout": true,
      "enableFourLayout": true,
      "fitLayoutCropRatio": "4:3",
      "font": {
        "color": "#ffffff",
        "style": [
          "900"
        ],
        "family": "Komika-axis",
        "stroke": {
          "enabled": true,
          "color": "#000000FF",
          "width": 16
        },
        "shadow": {
          "enabled": true,
          "color": "#FFFFFFFF",
          "x": 2,
          "y": 2,
          "blur": 16
        },
        "id": "font123",
        "type": "CustomizedFont",
        "name": "Arial",
        "path": "/fonts/arial.ttf",
        "size": "Large",
        "numericalSize": 50,
        "textDecoration": "underline"
      },
      "highlightColor": {
        "primary": "#ff0000",
        "secondary": "#00ff00"
      }
    },
    "type": "PresetOverwrite"
  }
]