magic_hour 0.21.0__py3-none-any.whl → 0.23.0__py3-none-any.whl

magic_hour/resources/v1/image_background_remover/README.md

@@ -1,8 +1,7 @@
 
-### create <a name="create"></a>
-Image Background Remover
+### Image Background Remover <a name="create"></a>
 
-Remove background from image. Each image costs 5 frames.
+Remove background from image. Each image costs 5 credits.
 
 **API Endpoint**: `POST /v1/image-background-remover`
 

magic_hour/resources/v1/image_background_remover/client.py

@@ -27,7 +27,7 @@ class ImageBackgroundRemoverClient:
         """
         Image Background Remover
 
-        Remove background from image. Each image costs 5 frames.
+        Remove background from image. Each image costs 5 credits.
 
         POST /v1/image-background-remover
 
@@ -81,7 +81,7 @@ class AsyncImageBackgroundRemoverClient:
         """
         Image Background Remover
 
-        Remove background from image. Each image costs 5 frames.
+        Remove background from image. Each image costs 5 credits.
 
         POST /v1/image-background-remover
 

magic_hour/resources/v1/image_projects/README.md

@@ -1,6 +1,5 @@
 
-### delete <a name="delete"></a>
-Delete image
+### Delete image <a name="delete"></a>
 
 Permanently delete the rendered image. This action is not reversible, please be sure before deleting.
 
@@ -26,8 +25,7 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.image_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
 ```
 
-### get <a name="get"></a>
-Get image details
+### Get image details <a name="get"></a>
 
 Get the details of a image project. The `downloads` field will be empty unless the image was successfully rendered.
 

magic_hour/resources/v1/image_to_video/README.md

@@ -1,6 +1,5 @@
 
-### create <a name="create"></a>
-Image-to-Video
+### Image-to-Video <a name="create"></a>
 
 Create a Image To Video 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.
   

magic_hour/resources/v1/lip_sync/README.md

@@ -1,6 +1,5 @@
 
-### create <a name="create"></a>
-Lip Sync
+### Lip Sync <a name="create"></a>
 
 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.
   

magic_hour/resources/v1/photo_colorizer/README.md

@@ -1,8 +1,7 @@
 
-### create <a name="create"></a>
-Photo Colorizer
+### Photo Colorizer <a name="create"></a>
 
-Colorize image. Each image costs 5 frames.
+Colorize image. Each image costs 5 credits.
 
 **API Endpoint**: `POST /v1/photo-colorizer`
 

magic_hour/resources/v1/photo_colorizer/client.py

@@ -27,7 +27,7 @@ class PhotoColorizerClient:
         """
         Photo Colorizer
 
-        Colorize image. Each image costs 5 frames.
+        Colorize image. Each image costs 5 credits.
 
         POST /v1/photo-colorizer
 
@@ -81,7 +81,7 @@ class AsyncPhotoColorizerClient:
         """
         Photo Colorizer
 
-        Colorize image. Each image costs 5 frames.
+        Colorize image. Each image costs 5 credits.
 
         POST /v1/photo-colorizer
 

magic_hour/resources/v1/text_to_video/README.md

@@ -1,6 +1,5 @@
 
-### create <a name="create"></a>
-Text-to-Video
+### Text-to-Video <a name="create"></a>
 
 Create a Text To Video 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.
   

magic_hour/resources/v1/video_projects/README.md

@@ -1,6 +1,5 @@
 
-### delete <a name="delete"></a>
-Delete video
+### Delete video <a name="delete"></a>
 
 Permanently delete the rendered video. This action is not reversible, please be sure before deleting.
 
@@ -26,8 +25,7 @@ client = AsyncClient(token=getenv("API_TOKEN"))
 res = await client.v1.video_projects.delete(id="cm6pvghix03bvyz0zwash6noj")
 ```
 
-### get <a name="get"></a>
-Get video details
+### Get video details <a name="get"></a>
 
 Get the details of a video project. The `downloads` field will be empty unless the video was successfully rendered.
 

magic_hour/resources/v1/video_to_video/README.md

@@ -1,6 +1,5 @@
 
-### create <a name="create"></a>
-Video-to-Video
+### Video-to-Video <a name="create"></a>
 
 Create a Video To Video 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.
   

magic_hour/types/models/v1_ai_clothes_changer_create_response.py

@@ -11,11 +11,19 @@ class V1AiClothesChangerCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_ai_face_editor_create_response.py

@@ -11,11 +11,19 @@ class V1AiFaceEditorCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_ai_gif_generator_create_response.py

@@ -11,11 +11,19 @@ class V1AiGifGeneratorCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_ai_headshot_generator_create_response.py

@@ -11,11 +11,19 @@ class V1AiHeadshotGeneratorCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_ai_image_generator_create_response.py

@@ -11,11 +11,19 @@ class V1AiImageGeneratorCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_ai_image_upscaler_create_response.py

@@ -11,11 +11,19 @@ class V1AiImageUpscalerCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_ai_meme_generator_create_response.py

@@ -11,11 +11,19 @@ class V1AiMemeGeneratorCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_ai_photo_editor_create_response.py

@@ -11,11 +11,19 @@ class V1AiPhotoEditorCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_ai_qr_code_generator_create_response.py

@@ -11,11 +11,19 @@ class V1AiQrCodeGeneratorCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_ai_talking_photo_create_response.py

@@ -11,11 +11,21 @@ class V1AiTalkingPhotoCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    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.
+    """
     estimated_frame_cost: int = pydantic.Field(
         alias="estimated_frame_cost",
     )
     """
-    Estimated cost of the video in terms of number of frames needed to render the video. Frames will be adjusted when the video completes
+    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.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_animation_create_response.py

@@ -11,11 +11,21 @@ class V1AnimationCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    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.
+    """
     estimated_frame_cost: int = pydantic.Field(
         alias="estimated_frame_cost",
     )
     """
-    Estimated cost of the video in terms of number of frames needed to render the video. Frames will be adjusted when the video completes
+    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.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_face_swap_create_response.py

@@ -11,15 +11,25 @@ class V1FaceSwapCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    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.
+    """
     estimated_frame_cost: int = pydantic.Field(
         alias="estimated_frame_cost",
     )
     """
-    Estimated cost of the video in terms of number of frames needed to render the video. Frames will be adjusted when the video completes
+    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.
     """
     id: str = pydantic.Field(
         alias="id",
     )
     """
-    Unique ID of the image. This value can be used in the [get image project API](https://docs.magichour.ai/api-reference/image-projects/get-image-details) to fetch additional details such as status
+    Unique ID of the video. This value can be used in the [get video project API](https://docs.magichour.ai/api-reference/video-projects/get-video-details) to fetch additional details such as status
     """

magic_hour/types/models/v1_face_swap_photo_create_response.py

@@ -11,11 +11,19 @@ class V1FaceSwapPhotoCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_image_background_remover_create_response.py

@@ -11,11 +11,19 @@ class V1ImageBackgroundRemoverCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_image_projects_get_response.py

@@ -21,6 +21,14 @@ class V1ImageProjectsGetResponse(pydantic.BaseModel):
     created_at: str = pydantic.Field(
         alias="created_at",
     )
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     downloads: typing.List[V1ImageProjectsGetResponseDownloadsItem] = pydantic.Field(
         alias="downloads",
     )
@@ -66,7 +74,7 @@ class V1ImageProjectsGetResponse(pydantic.BaseModel):
         alias="total_frame_cost",
     )
     """
-    The amount of frames used to generate the image.
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     type_: str = pydantic.Field(
         alias="type",

magic_hour/types/models/v1_image_to_video_create_response.py

@@ -11,11 +11,21 @@ class V1ImageToVideoCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    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.
+    """
     estimated_frame_cost: int = pydantic.Field(
         alias="estimated_frame_cost",
     )
     """
-    Estimated cost of the video in terms of number of frames needed to render the video. Frames will be adjusted when the video completes
+    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.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_lip_sync_create_response.py

@@ -11,11 +11,21 @@ class V1LipSyncCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    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.
+    """
     estimated_frame_cost: int = pydantic.Field(
         alias="estimated_frame_cost",
     )
     """
-    Estimated cost of the video in terms of number of frames needed to render the video. Frames will be adjusted when the video completes
+    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.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_photo_colorizer_create_response.py

@@ -11,11 +11,19 @@ class V1PhotoColorizerCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    The amount of credits deducted from your account to generate the image. We charge credits right when the request is made. 
+    
+    If an error occurred while generating the image(s), credits will be refunded and this field will be updated to include the refund.
+    """
     frame_cost: int = pydantic.Field(
         alias="frame_cost",
     )
     """
-    The frame cost of the image generation
+    Deprecated: Previously represented the number of frames (original name of our credit system) used for image generation. Use 'credits_charged' instead.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_text_to_video_create_response.py

@@ -11,11 +11,21 @@ class V1TextToVideoCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    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.
+    """
     estimated_frame_cost: int = pydantic.Field(
         alias="estimated_frame_cost",
     )
     """
-    Estimated cost of the video in terms of number of frames needed to render the video. Frames will be adjusted when the video completes
+    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.
     """
     id: str = pydantic.Field(
         alias="id",

magic_hour/types/models/v1_video_projects_get_response.py

@@ -22,6 +22,14 @@ class V1VideoProjectsGetResponse(pydantic.BaseModel):
     created_at: str = pydantic.Field(
         alias="created_at",
     )
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    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.
+    """
     download: typing.Optional[V1VideoProjectsGetResponseDownload] = pydantic.Field(
         alias="download",
     )
@@ -91,6 +99,8 @@ class V1VideoProjectsGetResponse(pydantic.BaseModel):
         alias="total_frame_cost",
     )
     """
+    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.
     """
     type_: str = pydantic.Field(

magic_hour/types/models/v1_video_to_video_create_response.py

@@ -11,11 +11,21 @@ class V1VideoToVideoCreateResponse(pydantic.BaseModel):
         populate_by_name=True,
     )
 
+    credits_charged: int = pydantic.Field(
+        alias="credits_charged",
+    )
+    """
+    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.
+    """
     estimated_frame_cost: int = pydantic.Field(
         alias="estimated_frame_cost",
     )
     """
-    Estimated cost of the video in terms of number of frames needed to render the video. Frames will be adjusted when the video completes
+    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.
     """
     id: str = pydantic.Field(
         alias="id",