cURL
curl --request GET \
--url https://api.opus.pro/api/brand-templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.opus.pro/api/brand-templates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.opus.pro/api/brand-templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.opus.pro/api/brand-templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.opus.pro/api/brand-templates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.opus.pro/api/brand-templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opus.pro/api/brand-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"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"
}
]Playground
Get Brand Templates
Retrieve a list of brand templates.
GET
/
api
/
brand-templates
cURL
curl --request GET \
--url https://api.opus.pro/api/brand-templates \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.opus.pro/api/brand-templates"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.opus.pro/api/brand-templates', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.opus.pro/api/brand-templates",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.opus.pro/api/brand-templates"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.opus.pro/api/brand-templates")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.opus.pro/api/brand-templates")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"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
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Available options:
mine Response
200 - application/json
Template ID
Example:
"cm32g2poc0002t5bnhmg2kfyx"
Template name
Example:
"Karaoke Template"
Is default template
Example:
true
Render preference
Show child attributes
Show child attributes
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 of template
Example:
"PresetOverwrite"
Was this page helpful?
⌘I