magic_hour 0.54.0

Magic Hour Rust SDK
Documentation 
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48

# v1.image_background_remover

## Module Functions

### Image Background Remover <a name="create"></a>

Remove background from image. Each image costs 5 credits.

**API Endpoint**: `POST /v1/image-background-remover`

#### Parameters

| Parameter                       | Required | Description                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   | Example                                                                                                                                                                    |
| ------------------------------- | :------: | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `assets`                        |    ✓     | Provide the assets for background removal                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     | `V1ImageBackgroundRemoverCreateBodyAssets {background_image_file_path: Some("api-assets/id/1234.png".to_string()), image_file_path: "api-assets/id/1234.png".to_string()}` |
| `└─ background_image_file_path` |    ✗     | The image used as the new background for the image_file_path. This image will be resized to match the image in image_file_path. Please make sure the resolution between the images are similar. 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). See the [file upload guide](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) for details. | `"api-assets/id/1234.png".to_string()`                                                                                                                                     |
| `└─ image_file_path`            |    ✓     | The image to remove the background. 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). See the [file upload guide](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls#input-file) for details.                                                                                                                                                             | `"api-assets/id/1234.png".to_string()`                                                                                                                                     |
| `name`                          |    ✗     | Give your image a custom name for easy identification.                                                                                                                                                                                                                                                                                                                                                                                                                                                                        | `"My Background Remover image".to_string()`                                                                                                                                |

#### Example Snippet

```rust
let client = magic_hour::Client::default()
    .with_bearer_auth(&std::env::var("API_TOKEN").unwrap());
let res = client
    .v1()
    .image_background_remover()
    .create(magic_hour::resources::v1::image_background_remover::CreateRequest {
        assets: magic_hour::models::V1ImageBackgroundRemoverCreateBodyAssets {
            background_image_file_path: Some("api-assets/id/1234.png".to_string()),
            image_file_path: "api-assets/id/1234.png".to_string(),
        },
        name: Some("My Background Remover image".to_string()),
    })
    .await;
```

#### Response

##### Type

[V1ImageBackgroundRemoverCreateResponse](/src/models/v1_image_background_remover_create_response.rs)

##### Example

```rust
V1ImageBackgroundRemoverCreateResponse {credits_charged: 5, frame_cost: 5, id: "cuid-example".to_string()}
```