PRpremierecopilot
Smart Captions

Preview

Changed on
post/api/smart-captions/preview

Request

  • Base URL
    https://api.premierecopilot.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.premierecopilot.com/api/smart-captions/preview
  • Auth
    OAuth 2
    Password
    Token URL: token

Request body

font_object_keystring required
font_namestring
transcriptionobject[] required
languagestring
direction'auto' | 'ltr' | 'rtl'
font_sizeinteger
colorinteger[]
letter_spacinginteger
strokes_widthinteger
strokes_colorinteger[]
is_boldboolean
is_italicboolean
is_all_capsboolean
no_punctuationboolean
nb_linesinteger
sequence_sizeinteger[]
frame_ratenumber
subtitles_boxboolean
shadowboolean
active_wordboolean
active_boxboolean
animationboolean
emojisboolean
shadow_colorinteger[]
shadow_opacitynumber
shadow_directionnumber
shadow_distancenumber
shadow_softnessnumber
left_colorinteger[] nullable
active_colorinteger[] nullable
right_colorinteger[] nullable
active_scalenumber
active_letter_spacingnumber
box_colorinteger[]
box_stroke_colorinteger[]
box_roundnessnumber
box_opacitynumber
box_padding_topnumber
box_padding_bottomnumber
box_horizontal_paddingnumber
box_stroke_widthnumber
active_box_colorinteger[]
active_box_stroke_colorinteger[]
active_box_roundnessnumber
active_box_opacitynumber
active_box_vertical_paddingnumber
active_box_horizontal_paddingnumber
active_box_stroke_widthnumber
animation_zoomboolean
animation_blurboolean
emoji_scalenumber
emoji_positionnumber[]
position_subtitlesnumber[]

Response

Successful Response

image_base64string required

Changes

  • 289449f8352eRevision changes
    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property