Create Font Profile API Endpoint
curl --request POST \
--url https://backend.clipvision.ai/api/font-profile/create/ \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"profile_name": "<string>",
"font_size": "<string>",
"font_bold": true,
"font_italic": true,
"font_underlined": true,
"font_strikethrough": true,
"caption_position": 123,
"caption_style_color": "<string>",
"caption_style_stroke_color": "<string>",
"caption_style_stroke_thickness": 123,
"caption_shadow_x_pos": 123,
"caption_shadow_y_pos": 123,
"caption_shadow_color": "<string>",
"caption_shadow_blur": 123,
"caption_lines": 123,
"caption_ai_keyword_highlighter": true,
"caption_ai_keyword_highlighter_color": "<string>",
"caption_highlighter": true,
"caption_highlighter_color": "<string>",
"preview_url": "<string>"
}
'import requests
url = "https://backend.clipvision.ai/api/font-profile/create/"
payload = {
"profile_name": "<string>",
"font_size": "<string>",
"font_bold": True,
"font_italic": True,
"font_underlined": True,
"font_strikethrough": True,
"caption_position": 123,
"caption_style_color": "<string>",
"caption_style_stroke_color": "<string>",
"caption_style_stroke_thickness": 123,
"caption_shadow_x_pos": 123,
"caption_shadow_y_pos": 123,
"caption_shadow_color": "<string>",
"caption_shadow_blur": 123,
"caption_lines": 123,
"caption_ai_keyword_highlighter": True,
"caption_ai_keyword_highlighter_color": "<string>",
"caption_highlighter": True,
"caption_highlighter_color": "<string>",
"preview_url": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
profile_name: '<string>',
font_size: '<string>',
font_bold: true,
font_italic: true,
font_underlined: true,
font_strikethrough: true,
caption_position: 123,
caption_style_color: '<string>',
caption_style_stroke_color: '<string>',
caption_style_stroke_thickness: 123,
caption_shadow_x_pos: 123,
caption_shadow_y_pos: 123,
caption_shadow_color: '<string>',
caption_shadow_blur: 123,
caption_lines: 123,
caption_ai_keyword_highlighter: true,
caption_ai_keyword_highlighter_color: '<string>',
caption_highlighter: true,
caption_highlighter_color: '<string>',
preview_url: '<string>'
})
};
fetch('https://backend.clipvision.ai/api/font-profile/create/', 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://backend.clipvision.ai/api/font-profile/create/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'profile_name' => '<string>',
'font_size' => '<string>',
'font_bold' => true,
'font_italic' => true,
'font_underlined' => true,
'font_strikethrough' => true,
'caption_position' => 123,
'caption_style_color' => '<string>',
'caption_style_stroke_color' => '<string>',
'caption_style_stroke_thickness' => 123,
'caption_shadow_x_pos' => 123,
'caption_shadow_y_pos' => 123,
'caption_shadow_color' => '<string>',
'caption_shadow_blur' => 123,
'caption_lines' => 123,
'caption_ai_keyword_highlighter' => true,
'caption_ai_keyword_highlighter_color' => '<string>',
'caption_highlighter' => true,
'caption_highlighter_color' => '<string>',
'preview_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://backend.clipvision.ai/api/font-profile/create/"
payload := strings.NewReader("{\n \"profile_name\": \"<string>\",\n \"font_size\": \"<string>\",\n \"font_bold\": true,\n \"font_italic\": true,\n \"font_underlined\": true,\n \"font_strikethrough\": true,\n \"caption_position\": 123,\n \"caption_style_color\": \"<string>\",\n \"caption_style_stroke_color\": \"<string>\",\n \"caption_style_stroke_thickness\": 123,\n \"caption_shadow_x_pos\": 123,\n \"caption_shadow_y_pos\": 123,\n \"caption_shadow_color\": \"<string>\",\n \"caption_shadow_blur\": 123,\n \"caption_lines\": 123,\n \"caption_ai_keyword_highlighter\": true,\n \"caption_ai_keyword_highlighter_color\": \"<string>\",\n \"caption_highlighter\": true,\n \"caption_highlighter_color\": \"<string>\",\n \"preview_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://backend.clipvision.ai/api/font-profile/create/")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"profile_name\": \"<string>\",\n \"font_size\": \"<string>\",\n \"font_bold\": true,\n \"font_italic\": true,\n \"font_underlined\": true,\n \"font_strikethrough\": true,\n \"caption_position\": 123,\n \"caption_style_color\": \"<string>\",\n \"caption_style_stroke_color\": \"<string>\",\n \"caption_style_stroke_thickness\": 123,\n \"caption_shadow_x_pos\": 123,\n \"caption_shadow_y_pos\": 123,\n \"caption_shadow_color\": \"<string>\",\n \"caption_shadow_blur\": 123,\n \"caption_lines\": 123,\n \"caption_ai_keyword_highlighter\": true,\n \"caption_ai_keyword_highlighter_color\": \"<string>\",\n \"caption_highlighter\": true,\n \"caption_highlighter_color\": \"<string>\",\n \"preview_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.clipvision.ai/api/font-profile/create/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile_name\": \"<string>\",\n \"font_size\": \"<string>\",\n \"font_bold\": true,\n \"font_italic\": true,\n \"font_underlined\": true,\n \"font_strikethrough\": true,\n \"caption_position\": 123,\n \"caption_style_color\": \"<string>\",\n \"caption_style_stroke_color\": \"<string>\",\n \"caption_style_stroke_thickness\": 123,\n \"caption_shadow_x_pos\": 123,\n \"caption_shadow_y_pos\": 123,\n \"caption_shadow_color\": \"<string>\",\n \"caption_shadow_blur\": 123,\n \"caption_lines\": 123,\n \"caption_ai_keyword_highlighter\": true,\n \"caption_ai_keyword_highlighter_color\": \"<string>\",\n \"caption_highlighter\": true,\n \"caption_highlighter_color\": \"<string>\",\n \"preview_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"font_profile_id": 1,
"disabled": false,
"profile_name": "New Font Profile",
"name": "Poppins",
"path": "Poppins",
"size": 30,
"bold": false,
"italic": false,
"underlined": false,
"strikethrough": false,
"caption_position": {
"coordinate_id": 0,
"overlay_visualizer": "Middle Center",
"x": "(main_w-overlay_w)/2",
"y": "(main_h-overlay_h)/2"
},
"caption_style_color": "#FFFFFF",
"caption_style_stroke_color": "#000000",
"caption_style_stroke_thickness": 2,
"caption_shadow_x_pos": 16,
"caption_shadow_y_pos": 14,
"caption_shadow_color": "#000000",
"caption_shadow_blur": 6,
"caption_lines": 1,
"caption_ai_keyword_highlighter": false,
"caption_ai_keyword_highlighter_color": "#80B8FF",
"caption_highlighter": true,
"caption_highlighter_color": "#FFFF00",
"preview_url": null
}This response has no body data.{
"success": false,
"error": "Internal Server Error"
}api
Create Font Profile API Endpoint
This API endpoint allows a user to create a new font profile.
POST
/
api
/
font-profile
/
create
/
Create Font Profile API Endpoint
curl --request POST \
--url https://backend.clipvision.ai/api/font-profile/create/ \
--header 'Authorization: Basic <encoded-value>' \
--header 'Content-Type: application/json' \
--data '
{
"profile_name": "<string>",
"font_size": "<string>",
"font_bold": true,
"font_italic": true,
"font_underlined": true,
"font_strikethrough": true,
"caption_position": 123,
"caption_style_color": "<string>",
"caption_style_stroke_color": "<string>",
"caption_style_stroke_thickness": 123,
"caption_shadow_x_pos": 123,
"caption_shadow_y_pos": 123,
"caption_shadow_color": "<string>",
"caption_shadow_blur": 123,
"caption_lines": 123,
"caption_ai_keyword_highlighter": true,
"caption_ai_keyword_highlighter_color": "<string>",
"caption_highlighter": true,
"caption_highlighter_color": "<string>",
"preview_url": "<string>"
}
'import requests
url = "https://backend.clipvision.ai/api/font-profile/create/"
payload = {
"profile_name": "<string>",
"font_size": "<string>",
"font_bold": True,
"font_italic": True,
"font_underlined": True,
"font_strikethrough": True,
"caption_position": 123,
"caption_style_color": "<string>",
"caption_style_stroke_color": "<string>",
"caption_style_stroke_thickness": 123,
"caption_shadow_x_pos": 123,
"caption_shadow_y_pos": 123,
"caption_shadow_color": "<string>",
"caption_shadow_blur": 123,
"caption_lines": 123,
"caption_ai_keyword_highlighter": True,
"caption_ai_keyword_highlighter_color": "<string>",
"caption_highlighter": True,
"caption_highlighter_color": "<string>",
"preview_url": "<string>"
}
headers = {
"Authorization": "Basic <encoded-value>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
body: JSON.stringify({
profile_name: '<string>',
font_size: '<string>',
font_bold: true,
font_italic: true,
font_underlined: true,
font_strikethrough: true,
caption_position: 123,
caption_style_color: '<string>',
caption_style_stroke_color: '<string>',
caption_style_stroke_thickness: 123,
caption_shadow_x_pos: 123,
caption_shadow_y_pos: 123,
caption_shadow_color: '<string>',
caption_shadow_blur: 123,
caption_lines: 123,
caption_ai_keyword_highlighter: true,
caption_ai_keyword_highlighter_color: '<string>',
caption_highlighter: true,
caption_highlighter_color: '<string>',
preview_url: '<string>'
})
};
fetch('https://backend.clipvision.ai/api/font-profile/create/', 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://backend.clipvision.ai/api/font-profile/create/",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'profile_name' => '<string>',
'font_size' => '<string>',
'font_bold' => true,
'font_italic' => true,
'font_underlined' => true,
'font_strikethrough' => true,
'caption_position' => 123,
'caption_style_color' => '<string>',
'caption_style_stroke_color' => '<string>',
'caption_style_stroke_thickness' => 123,
'caption_shadow_x_pos' => 123,
'caption_shadow_y_pos' => 123,
'caption_shadow_color' => '<string>',
'caption_shadow_blur' => 123,
'caption_lines' => 123,
'caption_ai_keyword_highlighter' => true,
'caption_ai_keyword_highlighter_color' => '<string>',
'caption_highlighter' => true,
'caption_highlighter_color' => '<string>',
'preview_url' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Basic <encoded-value>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://backend.clipvision.ai/api/font-profile/create/"
payload := strings.NewReader("{\n \"profile_name\": \"<string>\",\n \"font_size\": \"<string>\",\n \"font_bold\": true,\n \"font_italic\": true,\n \"font_underlined\": true,\n \"font_strikethrough\": true,\n \"caption_position\": 123,\n \"caption_style_color\": \"<string>\",\n \"caption_style_stroke_color\": \"<string>\",\n \"caption_style_stroke_thickness\": 123,\n \"caption_shadow_x_pos\": 123,\n \"caption_shadow_y_pos\": 123,\n \"caption_shadow_color\": \"<string>\",\n \"caption_shadow_blur\": 123,\n \"caption_lines\": 123,\n \"caption_ai_keyword_highlighter\": true,\n \"caption_ai_keyword_highlighter_color\": \"<string>\",\n \"caption_highlighter\": true,\n \"caption_highlighter_color\": \"<string>\",\n \"preview_url\": \"<string>\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Basic <encoded-value>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://backend.clipvision.ai/api/font-profile/create/")
.header("Authorization", "Basic <encoded-value>")
.header("Content-Type", "application/json")
.body("{\n \"profile_name\": \"<string>\",\n \"font_size\": \"<string>\",\n \"font_bold\": true,\n \"font_italic\": true,\n \"font_underlined\": true,\n \"font_strikethrough\": true,\n \"caption_position\": 123,\n \"caption_style_color\": \"<string>\",\n \"caption_style_stroke_color\": \"<string>\",\n \"caption_style_stroke_thickness\": 123,\n \"caption_shadow_x_pos\": 123,\n \"caption_shadow_y_pos\": 123,\n \"caption_shadow_color\": \"<string>\",\n \"caption_shadow_blur\": 123,\n \"caption_lines\": 123,\n \"caption_ai_keyword_highlighter\": true,\n \"caption_ai_keyword_highlighter_color\": \"<string>\",\n \"caption_highlighter\": true,\n \"caption_highlighter_color\": \"<string>\",\n \"preview_url\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://backend.clipvision.ai/api/font-profile/create/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Basic <encoded-value>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"profile_name\": \"<string>\",\n \"font_size\": \"<string>\",\n \"font_bold\": true,\n \"font_italic\": true,\n \"font_underlined\": true,\n \"font_strikethrough\": true,\n \"caption_position\": 123,\n \"caption_style_color\": \"<string>\",\n \"caption_style_stroke_color\": \"<string>\",\n \"caption_style_stroke_thickness\": 123,\n \"caption_shadow_x_pos\": 123,\n \"caption_shadow_y_pos\": 123,\n \"caption_shadow_color\": \"<string>\",\n \"caption_shadow_blur\": 123,\n \"caption_lines\": 123,\n \"caption_ai_keyword_highlighter\": true,\n \"caption_ai_keyword_highlighter_color\": \"<string>\",\n \"caption_highlighter\": true,\n \"caption_highlighter_color\": \"<string>\",\n \"preview_url\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"font_profile_id": 1,
"disabled": false,
"profile_name": "New Font Profile",
"name": "Poppins",
"path": "Poppins",
"size": 30,
"bold": false,
"italic": false,
"underlined": false,
"strikethrough": false,
"caption_position": {
"coordinate_id": 0,
"overlay_visualizer": "Middle Center",
"x": "(main_w-overlay_w)/2",
"y": "(main_h-overlay_h)/2"
},
"caption_style_color": "#FFFFFF",
"caption_style_stroke_color": "#000000",
"caption_style_stroke_thickness": 2,
"caption_shadow_x_pos": 16,
"caption_shadow_y_pos": 14,
"caption_shadow_color": "#000000",
"caption_shadow_blur": 6,
"caption_lines": 1,
"caption_ai_keyword_highlighter": false,
"caption_ai_keyword_highlighter_color": "#80B8FF",
"caption_highlighter": true,
"caption_highlighter_color": "#FFFF00",
"preview_url": null
}This response has no body data.{
"success": false,
"error": "Internal Server Error"
}Authorizations
Basicapi_key
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Body
application/json
Minimum string length:
1Available options:
local_files/fonts/BalderLL.ttf, local_files/fonts/Bangers-Regular.ttf, local_files/fonts/Fontspring-DEMO-FoundationSans-Black.otf, local_files/fonts/Geologica_Cursive-Black.ttf, local_files/fonts/Poppins-Black.ttf, local_files/fonts/RationalDisplay-Black.ttf, local_files/fonts/RationalDisplay-Bold.ttf, local_files/fonts/RationalDisplay-ExtraBold.ttf, local_files/fonts/Sequel Sans Bold Body.ttf, local_files/fonts/Sequel Sans Medium Body.ttf Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1Minimum string length:
1Response
Successfully created a new font profile
Font Profile OpenAPI Schema
Overlay Coordinate OpenAPI Schema
Show child attributes
Show child attributes
⌘I