Skip to main content
GET
/
api
/
font-profile
/
Get Font Profile API Endpoint
curl --request GET \
  --url https://backend.clipvision.ai/api/font-profile/ \
  --header 'Authorization: Basic <encoded-value>'
{
  "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.

Query Parameters

font_profile_id
integer
required
preview
boolean
default:false

Response

Successfully retrieved the 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