GET
/
api
/
brand-templates
cURL
curl --request GET \
  --url https://api.opus.pro/api/brand-templates \
  --header 'Authorization: Bearer <token>'
[
  {
    "templateId": "cm32g2poc0002t5bnhmg2kfyx",
    "name": "Karaoke Template",
    "isDefault": true,
    "preferences": {
      "enableAutoLayout": false,
      "enableFillLayout": false,
      "enableFitLayout": false,
      "fitLayoutCropRatio": "4:3",
      "enableSplitLayout": true,
      "enableThreeLayout": true,
      "enableFourLayout": true,
      "enableScreenLayout": true,
      "enableVisualHook": false,
      "enableWatermark": false,
      "enableCrop": true,
      "enableCaption": true,
      "enableUppercase": true,
      "enableHighlight": true,
      "enableEmoji": true,
      "font": {
        "color": "#ffffff",
        "style": [
          "900"
        ],
        "family": "Komika-axis",
        "stroke": {
          "enabled": false,
          "color": "#000000FF",
          "width": 16
        },
        "shadow": {
          "enabled": true,
          "color": "#FFFFFFFF",
          "x": 2,
          "y": 2,
          "blur": 16
        }
      },
      "highlightColor": {
        "primary": "#04f827",
        "secondary": "#FFFD03"
      }
    },
    "type": "PresetOverwrite"
  }
]
👆Use above tools to generate API request code snippets.

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

​
q
enum<string>
required
Available options:
mine

Response

200 - application/json
​
templateId
string
required

Template ID

Example:

"cm32g2poc0002t5bnhmg2kfyx"

​
name
string
required

Template name

Example:

"Karaoke Template"

​
isDefault
boolean
required

Is default template

Example:

true

​
preferences
object
required

Render preference

Example:
{
  "enableAutoLayout": false,
  "enableFillLayout": false,
  "enableFitLayout": false,
  "fitLayoutCropRatio": "4:3",
  "enableSplitLayout": true,
  "enableThreeLayout": true,
  "enableFourLayout": true,
  "enableScreenLayout": true,
  "enableVisualHook": false,
  "enableWatermark": false,
  "enableCrop": true,
  "enableCaption": true,
  "enableUppercase": true,
  "enableHighlight": true,
  "enableEmoji": true,
  "font": {
    "color": "#ffffff",
    "style": ["900"],
    "family": "Komika-axis",
    "stroke": {
      "enabled": false,
      "color": "#000000FF",
      "width": 16
    },
    "shadow": {
      "enabled": true,
      "color": "#FFFFFFFF",
      "x": 2,
      "y": 2,
      "blur": 16
    }
  },
  "highlightColor": {
    "primary": "#04f827",
    "secondary": "#FFFD03"
  }
}
​
type
string

Type of template

Example:

"PresetOverwrite"