magic_hour 0.34.0__py3-none-any.whl → 0.36.0__py3-none-any.whl

magic_hour/resources/v1/lip_sync/client.py

@@ -1,3 +1,4 @@
+import logging
 import typing
 
 from magic_hour.core import (
@@ -8,13 +9,121 @@ from magic_hour.core import (
     to_encodable,
     type_utils,
 )
+from magic_hour.resources.v1.files.client import AsyncFilesClient, FilesClient
+from magic_hour.resources.v1.video_projects.client import (
+    AsyncVideoProjectsClient,
+    VideoProjectsClient,
+)
 from magic_hour.types import models, params
 
 
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+
 class LipSyncClient:
     def __init__(self, *, base_client: SyncBaseClient):
         self._base_client = base_client
 
+    def generate(
+        self,
+        *,
+        assets: params.V1LipSyncGenerateBodyAssets,
+        end_seconds: float,
+        start_seconds: float,
+        height: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        max_fps_limit: typing.Union[
+            typing.Optional[float], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        width: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate lip sync video (alias for create with additional functionality).
+
+        Create a Lip Sync video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
+
+        Args:
+            height: `height` is deprecated and no longer influences the output video's resolution.
+            max_fps_limit: Defines the maximum FPS (frames per second) for the output video. If the input video's FPS is lower than this limit, the output video will retain the input FPS. This is useful for reducing unnecessary frame usage in scenarios where high FPS is not required.
+            name: The name of video. This value is mainly used for your own identification of the video.
+            width: `width` is deprecated and no longer influences the output video's resolution.
+            assets: Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
+            end_seconds: 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.
+            start_seconds: 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.
+            wait_for_completion: Whether to wait for the video project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1VideoProjectsGetResponseWithDownloads: The response from the Lip Sync API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = client.v1.lip_sync.generate(
+            assets={
+                "audio_file_path": "path/to/audio.mp3",
+                "video_file_path": "path/to/video.mp4",
+                "video_source": "file",
+            },
+            end_seconds=15.0,
+            start_seconds=0.0,
+            max_fps_limit=12.0,
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        file_client = FilesClient(base_client=self._base_client)
+
+        # Upload audio file (always required)
+        audio_file_path = assets["audio_file_path"]
+        assets["audio_file_path"] = file_client.upload_file(file=audio_file_path)
+
+        # Upload video file if video_source is "file" and video_file_path is provided
+        if (
+            assets.get("video_source") == "file"
+            and "video_file_path" in assets
+            and assets["video_file_path"]
+        ):
+            video_file_path = assets["video_file_path"]
+            assets["video_file_path"] = file_client.upload_file(file=video_file_path)
+
+        create_response = self.create(
+            assets=assets,
+            end_seconds=end_seconds,
+            start_seconds=start_seconds,
+            height=height,
+            max_fps_limit=max_fps_limit,
+            name=name,
+            width=width,
+            request_options=request_options,
+        )
+        logger.info(f"Lip Sync response: {create_response}")
+
+        video_projects_client = VideoProjectsClient(base_client=self._base_client)
+        response = video_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
     def create(
         self,
         *,
@@ -46,24 +155,22 @@ class LipSyncClient:
         POST /v1/lip-sync
 
         Args:
-            height: Used to determine the dimensions of the output video.
-
-        * If height is provided, width will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio.
-        * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.
+            height: `height` is deprecated and no longer influences the output video's resolution.
 
-        Note: if the video's original resolution is less than the maximum, the video will not be resized.
+        Output resolution is determined by the **minimum** of:
+        - The resolution of the input video
+        - The maximum resolution allowed by your subscription tier. See our [pricing page](https://magichour.ai/pricing) for more details.
 
-        See our [pricing page](https://magichour.ai/pricing) for more details.
+        This field is retained only for backward compatibility and will be removed in a future release.
             max_fps_limit: Defines the maximum FPS (frames per second) for the output video. If the input video's FPS is lower than this limit, the output video will retain the input FPS. This is useful for reducing unnecessary frame usage in scenarios where high FPS is not required.
             name: The name of video. This value is mainly used for your own identification of the video.
-            width: Used to determine the dimensions of the output video.
+            width: `width` is deprecated and no longer influences the output video's resolution.
 
-        * If width is provided, height will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio.
-        * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.
+        Output resolution is determined by the **minimum** of:
+        - The resolution of the input video
+        - The maximum resolution allowed by your subscription tier. See our [pricing page](https://magichour.ai/pricing) for more details.
 
-        Note: if the video's original resolution is less than the maximum, the video will not be resized.
-
-        See our [pricing page](https://magichour.ai/pricing) for more details.
+        This field is retained only for backward compatibility and will be removed in a future release.
             assets: Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
             end_seconds: 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.
             start_seconds: 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.
@@ -86,10 +193,8 @@ class LipSyncClient:
             },
             end_seconds=15.0,
             start_seconds=0.0,
-            height=960,
             max_fps_limit=12.0,
             name="Lip Sync video",
-            width=512,
         )
         ```
         """
@@ -119,6 +224,107 @@ class AsyncLipSyncClient:
     def __init__(self, *, base_client: AsyncBaseClient):
         self._base_client = base_client
 
+    async def generate(
+        self,
+        *,
+        assets: params.V1LipSyncGenerateBodyAssets,
+        end_seconds: float,
+        start_seconds: float,
+        height: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        max_fps_limit: typing.Union[
+            typing.Optional[float], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        width: typing.Union[
+            typing.Optional[int], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate lip sync video (alias for create with additional functionality).
+
+        Create a Lip Sync video. The estimated frame cost is calculated using 30 FPS. This amount is deducted from your account balance when a video is queued. Once the video is complete, the cost will be updated based on the actual number of frames rendered.
+
+        Args:
+            height: `height` is deprecated and no longer influences the output video's resolution.
+            max_fps_limit: Defines the maximum FPS (frames per second) for the output video. If the input video's FPS is lower than this limit, the output video will retain the input FPS. This is useful for reducing unnecessary frame usage in scenarios where high FPS is not required.
+            name: The name of video. This value is mainly used for your own identification of the video.
+            width: `width` is deprecated and no longer influences the output video's resolution.
+            assets: Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
+            end_seconds: 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.
+            start_seconds: 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.
+            wait_for_completion: Whether to wait for the video project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1VideoProjectsGetResponseWithDownloads: The response from the Lip Sync API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = await client.v1.lip_sync.generate(
+            assets={
+                "audio_file_path": "path/to/audio.mp3",
+                "video_file_path": "path/to/video.mp4",
+                "video_source": "file",
+            },
+            end_seconds=15.0,
+            start_seconds=0.0,
+            max_fps_limit=12.0,
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        file_client = AsyncFilesClient(base_client=self._base_client)
+
+        # Upload audio file (always required)
+        audio_file_path = assets["audio_file_path"]
+        assets["audio_file_path"] = await file_client.upload_file(file=audio_file_path)
+
+        # Upload video file if video_source is "file" and video_file_path is provided
+        if (
+            assets.get("video_source") == "file"
+            and "video_file_path" in assets
+            and assets["video_file_path"]
+        ):
+            video_file_path = assets["video_file_path"]
+            assets["video_file_path"] = await file_client.upload_file(
+                file=video_file_path
+            )
+
+        create_response = await self.create(
+            assets=assets,
+            end_seconds=end_seconds,
+            start_seconds=start_seconds,
+            height=height,
+            max_fps_limit=max_fps_limit,
+            name=name,
+            width=width,
+            request_options=request_options,
+        )
+        logger.info(f"Lip Sync response: {create_response}")
+
+        video_projects_client = AsyncVideoProjectsClient(base_client=self._base_client)
+        response = await video_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
     async def create(
         self,
         *,
@@ -150,24 +356,22 @@ class AsyncLipSyncClient:
         POST /v1/lip-sync
 
         Args:
-            height: Used to determine the dimensions of the output video.
-
-        * If height is provided, width will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio.
-        * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.
+            height: `height` is deprecated and no longer influences the output video's resolution.
 
-        Note: if the video's original resolution is less than the maximum, the video will not be resized.
+        Output resolution is determined by the **minimum** of:
+        - The resolution of the input video
+        - The maximum resolution allowed by your subscription tier. See our [pricing page](https://magichour.ai/pricing) for more details.
 
-        See our [pricing page](https://magichour.ai/pricing) for more details.
+        This field is retained only for backward compatibility and will be removed in a future release.
             max_fps_limit: Defines the maximum FPS (frames per second) for the output video. If the input video's FPS is lower than this limit, the output video will retain the input FPS. This is useful for reducing unnecessary frame usage in scenarios where high FPS is not required.
             name: The name of video. This value is mainly used for your own identification of the video.
-            width: Used to determine the dimensions of the output video.
-
-        * If width is provided, height will also be required. The larger value between width and height will be used to determine the maximum output resolution while maintaining the original aspect ratio.
-        * If both height and width are omitted, the video will be resized according to your subscription's maximum resolution, while preserving aspect ratio.
+            width: `width` is deprecated and no longer influences the output video's resolution.
 
-        Note: if the video's original resolution is less than the maximum, the video will not be resized.
+        Output resolution is determined by the **minimum** of:
+        - The resolution of the input video
+        - The maximum resolution allowed by your subscription tier. See our [pricing page](https://magichour.ai/pricing) for more details.
 
-        See our [pricing page](https://magichour.ai/pricing) for more details.
+        This field is retained only for backward compatibility and will be removed in a future release.
             assets: Provide the assets for lip-sync. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used
             end_seconds: 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.
             start_seconds: 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.
@@ -190,10 +394,8 @@ class AsyncLipSyncClient:
             },
             end_seconds=15.0,
             start_seconds=0.0,
-            height=960,
             max_fps_limit=12.0,
             name="Lip Sync video",
-            width=512,
         )
         ```
         """

magic_hour/resources/v1/photo_colorizer/README.md

@@ -1,3 +1,60 @@
+# v1_photo_colorizer
+
+## Module Functions
+
+<!-- CUSTOM DOCS START -->
+
+### Photo Colorizer Generate Workflow <a name="generate"></a>
+
+The workflow performs the following action
+
+1. upload local assets to Magic Hour storage. So you can pass in a local path instead of having to upload files yourself
+2. trigger a generation
+3. poll for a completion status. This is configurable
+4. if success, download the output to local directory
+
+> [!TIP]
+> This is the recommended way to use the SDK unless you have specific needs where it is necessary to split up the actions.
+
+#### Parameters
+
+In Additional to the parameters listed in the `.create` section below, `.generate` introduces 3 new parameters:
+
+- `wait_for_completion` (bool, default True): Whether to wait for the project to complete.
+- `download_outputs` (bool, default True): Whether to download the generated files
+- `download_directory` (str, optional): Directory to save downloaded files (defaults to current directory)
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.photo_colorizer.generate(
+    assets={"image_file_path": "/path/to/1234.png"}, name="Photo Colorizer image"
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.photo_colorizer.generate(
+    assets={"image_file_path": "/path/to/1234.png"}, name="Photo Colorizer image"
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+<!-- CUSTOM DOCS END -->
 
 ### Photo Colorizer <a name="create"></a>
 
@@ -10,6 +67,7 @@ Colorize image. Each image costs 5 credits.
 | Parameter | Required | Description | Example |
 |-----------|:--------:|-------------|--------|
 | `assets` | ✓ | Provide the assets for photo colorization | `{"image_file_path": "api-assets/id/1234.png"}` |
+| `└─ image_file_path` | ✓ | The image used to generate the colorized image. This value is either - a direct URL to the video file - `file_path` field from the response of the [upload urls API](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls).  Please refer to the [Input File documentation](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) to learn more.  | `"api-assets/id/1234.png"` |
 | `name` | ✗ | The name of image. This value is mainly used for your own identification of the image. | `"Photo Colorizer image"` |
 
 #### Synchronous Client
@@ -45,3 +103,4 @@ res = await client.v1.photo_colorizer.create(
 
 ##### Example
 `{"credits_charged": 5, "frame_cost": 5, "id": "cuid-example"}`
+

magic_hour/resources/v1/photo_colorizer/client.py

@@ -1,3 +1,4 @@
+import logging
 import typing
 
 from magic_hour.core import (
@@ -8,13 +9,82 @@ from magic_hour.core import (
     to_encodable,
     type_utils,
 )
+from magic_hour.resources.v1.files.client import AsyncFilesClient, FilesClient
+from magic_hour.resources.v1.image_projects.client import (
+    AsyncImageProjectsClient,
+    ImageProjectsClient,
+)
 from magic_hour.types import models, params
 
 
+logging.basicConfig(level=logging.INFO)
+logger = logging.getLogger(__name__)
+
+
 class PhotoColorizerClient:
     def __init__(self, *, base_client: SyncBaseClient):
         self._base_client = base_client
 
+    def generate(
+        self,
+        *,
+        assets: params.V1PhotoColorizerGenerateBodyAssets,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate colorized photo (alias for create with additional functionality).
+
+        Colorize image. Each image costs 5 credits.
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the image.
+            assets: Provide the assets for photo colorization
+            wait_for_completion: Whether to wait for the image project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1ImageProjectsGetResponseWithDownloads: The response from the Photo Colorizer API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = client.v1.photo_colorizer.generate(
+            assets={"image_file_path": "path/to/black_white_photo.jpg"},
+            name="Colorized Photo",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        file_client = FilesClient(base_client=self._base_client)
+
+        image_file_path = assets["image_file_path"]
+        assets["image_file_path"] = file_client.upload_file(file=image_file_path)
+
+        create_response = self.create(
+            assets=assets, name=name, request_options=request_options
+        )
+        logger.info(f"Photo Colorizer response: {create_response}")
+
+        image_projects_client = ImageProjectsClient(base_client=self._base_client)
+        response = image_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
     def create(
         self,
         *,
@@ -69,6 +139,66 @@ class AsyncPhotoColorizerClient:
     def __init__(self, *, base_client: AsyncBaseClient):
         self._base_client = base_client
 
+    async def generate(
+        self,
+        *,
+        assets: params.V1PhotoColorizerGenerateBodyAssets,
+        name: typing.Union[
+            typing.Optional[str], type_utils.NotGiven
+        ] = type_utils.NOT_GIVEN,
+        wait_for_completion: bool = True,
+        download_outputs: bool = True,
+        download_directory: typing.Optional[str] = None,
+        request_options: typing.Optional[RequestOptions] = None,
+    ):
+        """
+        Generate colorized photo (alias for create with additional functionality).
+
+        Colorize image. Each image costs 5 credits.
+
+        Args:
+            name: The name of image. This value is mainly used for your own identification of the image.
+            assets: Provide the assets for photo colorization
+            wait_for_completion: Whether to wait for the image project to complete
+            download_outputs: Whether to download the outputs
+            download_directory: The directory to download the outputs to. If not provided, the outputs will be downloaded to the current working directory
+            request_options: Additional options to customize the HTTP request
+
+        Returns:
+            V1ImageProjectsGetResponseWithDownloads: The response from the Photo Colorizer API with the downloaded paths if `download_outputs` is True.
+
+        Examples:
+        ```py
+        response = await client.v1.photo_colorizer.generate(
+            assets={"image_file_path": "path/to/black_white_photo.jpg"},
+            name="Colorized Photo",
+            wait_for_completion=True,
+            download_outputs=True,
+            download_directory="outputs/",
+        )
+        ```
+        """
+
+        file_client = AsyncFilesClient(base_client=self._base_client)
+
+        image_file_path = assets["image_file_path"]
+        assets["image_file_path"] = await file_client.upload_file(file=image_file_path)
+
+        create_response = await self.create(
+            assets=assets, name=name, request_options=request_options
+        )
+        logger.info(f"Photo Colorizer response: {create_response}")
+
+        image_projects_client = AsyncImageProjectsClient(base_client=self._base_client)
+        response = await image_projects_client.check_result(
+            id=create_response.id,
+            wait_for_completion=wait_for_completion,
+            download_outputs=download_outputs,
+            download_directory=download_directory,
+        )
+
+        return response
+
     async def create(
         self,
         *,

magic_hour/resources/v1/text_to_video/README.md

@@ -1,3 +1,68 @@
+# v1_text_to_video
+
+## Module Functions
+
+<!-- CUSTOM DOCS START -->
+
+### Text To Video Generate Workflow <a name="generate"></a>
+
+The workflow performs the following action
+
+1. upload local assets to Magic Hour storage. So you can pass in a local path instead of having to upload files yourself
+2. trigger a generation
+3. poll for a completion status. This is configurable
+4. if success, download the output to local directory
+
+> [!TIP]
+> This is the recommended way to use the SDK unless you have specific needs where it is necessary to split up the actions.
+
+#### Parameters
+
+In Additional to the parameters listed in the `.create` section below, `.generate` introduces 3 new parameters:
+
+- `wait_for_completion` (bool, default True): Whether to wait for the project to complete.
+- `download_outputs` (bool, default True): Whether to download the generated files
+- `download_directory` (str, optional): Directory to save downloaded files (defaults to current directory)
+
+#### Synchronous Client
+
+```python
+from magic_hour import Client
+from os import getenv
+
+client = Client(token=getenv("API_TOKEN"))
+res = client.v1.text_to_video.generate(
+    end_seconds=5.0,
+    orientation="landscape",
+    style={"prompt": "a dog running"},
+    name="Text To Video video",
+    resolution="720p",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+#### Asynchronous Client
+
+```python
+from magic_hour import AsyncClient
+from os import getenv
+
+client = AsyncClient(token=getenv("API_TOKEN"))
+res = await client.v1.text_to_video.generate(
+    end_seconds=5.0,
+    orientation="landscape",
+    style={"prompt": "a dog running"},
+    name="Text To Video video",
+    resolution="720p",
+    wait_for_completion=True,
+    download_outputs=True,
+    download_directory="outputs"
+)
+```
+
+<!-- CUSTOM DOCS END -->
 
 ### Text-to-Video <a name="create"></a>
 
@@ -15,6 +80,8 @@ Get more information about this mode at our [product page](https://magichour.ai/
 | `end_seconds` | ✓ | The total duration of the output video in seconds.  The value must be greater than or equal to 5 seconds and less than or equal to 60 seconds.  Note: For 480p resolution, the value must be either 5 or 10. | `5.0` |
 | `orientation` | ✓ | Determines the orientation of the output video | `"landscape"` |
 | `style` | ✓ |  | `{"prompt": "a dog running"}` |
+| `└─ prompt` | ✓ | The prompt used for the video. | `"a dog running"` |
+| `└─ quality_mode` | ✗ | DEPRECATED: Please use `resolution` field instead. For backward compatibility: * `quick` maps to 720p resolution * `studio` maps to 1080p resolution  This field will be removed in a future version. Use the `resolution` field to directly to specify the resolution. | `"quick"` |
 | `name` | ✗ | The name of video. This value is mainly used for your own identification of the video. | `"Text To Video video"` |
 | `resolution` | ✗ | Controls the output video resolution. Defaults to `720p` if not specified.  480p and 720p are available on Creator, Pro, or Business tiers. However, 1080p require Pro or Business tier.  **Options:** - `480p` - Supports only 5 or 10 second videos. Output: 24fps. Cost: 120 credits per 5 seconds. - `720p` - Supports videos between 5-60 seconds. Output: 30fps. Cost: 300 credits per 5 seconds. - `1080p` - Supports videos between 5-60 seconds. Output: 30fps. Cost: 600 credits per 5 seconds. | `"720p"` |
 
@@ -59,3 +126,4 @@ res = await client.v1.text_to_video.create(
 
 ##### Example
 `{"credits_charged": 450, "estimated_frame_cost": 450, "id": "cuid-example"}`
+