Skip to main content
GET
Get Font Profile API Endpoint

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
Overlay Coordinate · 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