Skip to main content
POST
/
v1
/
auto-subtitle-generator
Python
from magic_hour import Client
from os import getenv

client = Client(token=getenv("API_TOKEN"))
res = client.v1.auto_subtitle_generator.generate(
    assets={"video_file_path": "/path/to/1234.mp4"},
    end_seconds=15.0,
    start_seconds=0.0,
    style={},
    name="Auto Subtitle video",
    wait_for_completion=True,
    download_outputs=True,
    download_directory="outputs"
)
{
  "id": "cuid-example",
  "estimated_frame_cost": 450,
  "credits_charged": 450
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <api_key>, where <api_key> is your API key. To get your API key, go to Developer Hub and click "Create new API Key".

Body

application/json

Body

​
start_seconds
number
required

The start time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.

Required range: x >= 0
Example:

0

​
end_seconds
number
required

The end time of the input video in seconds. This value is used to trim the input video. The value must be greater than 0.1, and more than the start_seconds.

Required range: x >= 0.1
Example:

15

​
assets
object
required

Provide the assets for auto subtitle generator

​
style
object
required

Style of the subtitle. At least one of .style.template or .style.custom_config must be provided.

  • If only .style.template is provided, default values for the template will be used.
  • If both are provided, the fields in .style.custom_config will be used to overwrite the fields in .style.template.
  • If only .style.custom_config is provided, then all fields in .style.custom_config will be used.

To use custom config only, the following custom_config params are required:

  • .style.custom_config.font
  • .style.custom_config.text_color
  • .style.custom_config.vertical_position
  • .style.custom_config.horizontal_position
​
name
string
default:Auto Subtitle - dateTime

The name of video. This value is mainly used for your own identification of the video.

Example:

"Auto Subtitle video"

Response

Success

​
id
string
required

Unique ID of the video. This value can be used in the get video project API to fetch additional details such as status

Example:

"cuid-example"

​
estimated_frame_cost
integer
required
deprecated

Deprecated: Previously represented the number of frames (original name of our credit system) used for video generation. Use 'credits_charged' instead.

The amount of frames used to generate the video. If the status is not 'complete', the cost is an estimate and will be adjusted when the video completes.

Example:

450

​
credits_charged
integer
required

The amount of credits deducted from your account to generate the video. If the status is not 'complete', this value is an estimate and may be adjusted upon completion based on the actual FPS of the output video.

If video generation fails, credits will be refunded, and this field will be updated to include the refund.

Example:

450

⌘I