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
49
50

# v1.head_swap

## Module Functions

### Head Swap <a name="create"></a>

Swap a head onto a body image. Each image costs 10 credits. Output resolution depends on your subscription; you may set `max_resolution` lower than your plan maximum if desired.

**API Endpoint**: `POST /v1/head-swap`

#### Parameters

| Parameter           | Required | Description                                                                                                                                                                                                                                                                                                                                                           | Example                                                                                                                                   |
| ------------------- | :------: | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- |
| `assets`            |    ✓     | Provide the body and head images for head swap                                                                                                                                                                                                                                                                                                                        | `V1HeadSwapCreateBodyAssets {body_file_path: "api-assets/id/1234.png".to_string(), head_file_path: "api-assets/id/5678.png".to_string()}` |
| `└─ body_file_path` |    ✓     | Image that receives the swapped head. 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()`                                                                                                    |
| `└─ head_file_path` |    ✓     | Image of the head to place on the body. 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/5678.png".to_string()`                                                                                                    |
| `max_resolution`    |    ✗     | Constrains the larger dimension (height or width) of the output. Omit to use the maximum allowed for your plan (capped at 2048px). Values above your plan maximum are clamped down to your plan's maximum.                                                                                                                                                            | `1024`                                                                                                                                    |
| `name`              |    ✗     | Give your image a custom name for easy identification.                                                                                                                                                                                                                                                                                                                | `"My Head Swap 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()
    .head_swap()
    .create(magic_hour::resources::v1::head_swap::CreateRequest {
        assets: magic_hour::models::V1HeadSwapCreateBodyAssets {
            body_file_path: "api-assets/id/1234.png".to_string(),
            head_file_path: "api-assets/id/5678.png".to_string(),
        },
        max_resolution: Some(1024),
        name: Some("My Head Swap image".to_string()),
    })
    .await;
```

#### Response

##### Type

[V1HeadSwapCreateResponse](/src/models/v1_head_swap_create_response.rs)

##### Example

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