Skip to main content
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_path": "",
  "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>"
}'
{
  "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
}

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Body

application/json
profile_name
string
required
Minimum length: 1
font_path
enum<string>
required
Available 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
font_size
string
required
Minimum length: 1
font_bold
boolean
required
font_italic
boolean
required
font_underlined
boolean
required
font_strikethrough
boolean
required
caption_position
integer
required
caption_style_color
string
required
Minimum length: 1
caption_style_stroke_color
string
required
Minimum length: 1
caption_style_stroke_thickness
integer
required
caption_shadow_x_pos
integer
required
caption_shadow_y_pos
integer
required
caption_shadow_color
string
required
Minimum length: 1
caption_shadow_blur
integer
required
caption_lines
integer
required
caption_ai_keyword_highlighter
boolean
required
caption_ai_keyword_highlighter_color
string
required
Minimum length: 1
caption_highlighter
boolean
required
caption_highlighter_color
string
required
Minimum length: 1
preview_url
string
required
Minimum length: 1

Response

Successfully created a new font profile

Font Profile OpenAPI Schema

font_profile_id
integer
disabled
boolean
profile_name
string
name
string
path
string
size
integer
bold
boolean
italic
boolean
underlined
boolean
strikethrough
boolean
caption_position
object

Overlay Coordinate OpenAPI Schema

caption_style_color
string
caption_style_stroke_color
string
caption_style_stroke_thickness
integer
caption_shadow_x_pos
integer
caption_shadow_y_pos
integer
caption_shadow_color
string
caption_shadow_blur
integer
caption_lines
integer
caption_ai_keyword_highlighter
boolean
caption_ai_keyword_highlighter_color
string
caption_highlighter
boolean
caption_highlighter_color
string
preview_url
string
preview_bytes
file