POST
javascript
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 const axios = require('axios'); const api_key = "YOUR API-KEY"; const url = "https://api.segmind.com/v1/video-captioner"; const data = { "MaxChars": 10, "bg_blur": false, "bg_color": "null", "color": "white", "font": "Poppins/Poppins-ExtraBold.ttf", "fontsize": 7, "highlight_color": "yellow", "input_video": "https://segmind-sd-models.s3.amazonaws.com/display_images/hallo_output.mp4", "kerning": -2, "opacity": 0, "right_to_left": false, "stroke_color": "black", "stroke_width": 2, "subs_position": "bottom75" }; (async function() { try { const response = await axios.post(url, data, { headers: { 'x-api-key': api_key } }); console.log(response.data); } catch (error) { console.error('Error:', error.response.data); } })();
RESPONSE
image/jpeg
HTTP Response Codes
200 - OKImage Generated
401 - UnauthorizedUser authentication failed
404 - Not FoundThe requested URL does not exist
405 - Method Not AllowedThe requested HTTP method is not allowed
406 - Not AcceptableNot enough credits
500 - Server ErrorServer had some issue with processing

Attributes


MaxCharsint ( default: 10 )

Max characters space for subtitles. 20 is good for videos, 10 is good for reels


bg_blurboolean ( default: 1 )

Blur the background colour of the subtitle


bg_colorenum:str ( default: null )

Background color of the subtitles

Allowed values:


colorenum:str ( default: white )

Color of the subtitles

Allowed values:


fontenum:str ( default: Poppins/Poppins-ExtraBold.ttf )

Font for the subtitles

Allowed values:


fontsizefloat ( default: 7 )

Font size. 7.0 is good for videos, 4.0 is good for reels


highlight_colorenum:str ( default: yellow )

Highlight color for subtitles

Allowed values:


input_videostr *

URL of the input video to be captioned


kerningfloat ( default: -2 )

Kerning (spacing between individual letters or characters) for the subtitles


opacityfloat ( default: 1 )

Opacity for the subtitles background


right_to_leftboolean ( default: 1 )

Right to left subtitles, for right to left languages. Only Arial fonts are supported.


stroke_colorenum:str ( default: black )

Stroke color for the subtitles

Allowed values:


stroke_widthfloat ( default: 2 )

Stroke width for the subtitles


subs_positionenum:str ( default: bottom75 )

Position of the subtitles

Allowed values:

To keep track of your credit usage, you can inspect the response headers of each API call. The x-remaining-credits property will indicate the number of remaining credits in your account. Ensure you monitor this value to avoid any disruptions in your API usage.

Video Captioner

The Video Captioner model is engineered to revolutionize the way you handle video subtitle integration, enhancing both accessibility and viewer engagement. Leveraging state-of-the-art algorithms, this tool provides a seamless process for generating precise video captions with customized stylistic options.

Key Features of Video Captioner

  • Dynamic Subtitle Positioning: Configure subtitles to display at your desired position, providing optimal readability by setting preferences such as bottom,top, left, right etc .

  • Customizable Aesthetics: Tailor subtitle appearance with comprehensive settings including color adjustments (e.g., white subtitles, yellow highlight, black stroke), font selection (such as Poppins ExtraBold), and precise font sizing.

  • Background and Opacity Control: Adjust transparency levels for subtitles and background color flexibility to ensure clarity and visibility on various video backgrounds.

  • Text Handling and Kerning: Fine-tune your text with a maximum character setting and kerning adjustments to achieve precise alignment and spacing for multilingual subtitles that adhere to right-to-left language requirements.

Use cases

  • Educational Content: Enhance online courses, lectures, and tutorials with clear and accurate subtitles, improving comprehension and accessibility for diverse learners.

  • Corporate Training: Facilitate employee training programs by providing captioned videos that cater to multilingual staff and those with hearing impairments.

  • Social Media Marketing: Boost engagement on platforms like YouTube, Instagram, and Facebook by adding eye-catching captions to videos, ensuring content is accessible even when muted.

  • Film and TV Production: Streamline the post-production process by efficiently generating subtitles, enabling faster distribution across different languages and regions.

  • E-Learning Platforms: Offer inclusive learning experiences by integrating subtitles in courses, allowing institutions to cater to global audiences.