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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
# v1.video_to_video
## Module Functions
### Video-to-Video <a name="create"></a>
**What this API does**
Create the same Video To Video you can make in the browser, but programmatically, so you can automate it, run it at scale, or connect it to your own app or workflow.
**Good for**
- Automation and batch processing
- Adding video to video into apps, pipelines, or tools
**How it works (3 steps)**
1. Upload your inputs (video, image, or audio) with [Generate Upload URLs](https://docs.magichour.ai/api-reference/files/generate-asset-upload-urls) and copy the `file_path`.
2. Send a request to create a video to video job with the basic fields.
3. Check the job status until it's `complete`, then download the result from `downloads`.
**Key options**
- Inputs: usually a file, sometimes a YouTube link, depending on project type
- Resolution: output size and plan requirements vary by workflow and model. Some workflows derive output size from the input video.
- Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt
**Cost**\
Credits are charged when the job is queued (`credits_charged` in the response). Tools billed per frame charge an estimate and settle to the frames that actually render once the job finishes; tools billed per second charge the final amount upfront. Failed jobs are refunded.
For detailed examples, see the [product page](https://magichour.ai/products/video-to-video).
V3 request example (upload both assets first):
```json
{"start_seconds":0,"end_seconds":2,"width":1024,"height":704,"fps":30,"fps_resolution":"HALF","style":{"art_style":"Studio Ghibli","version":"v3","model":"default"},"assets":{"video_source":"file","video_file_path":"api-assets/id/video.mp4","initial_image_path":"api-assets/id/reference.png"}}
```
V3 supports up to 1,200 output frames for square videos and 800 otherwise.
**API Endpoint**: `POST /v1/video-to-video`
#### Parameters
| Parameter | Required | Description | Example |
| ----------------------- | :------: | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `assets` | ✓ | Provide the assets for video-to-video. For video, The `video_source` field determines whether `video_file_path` or `youtube_url` field is used | `V1VideoToVideoCreateBodyAssets {video_file_path: Some("api-assets/id/1234.mp4".to_string()), video_source: V1VideoToVideoCreateBodyAssetsVideoSourceEnum::File, ..Default::default()}` |
| `└─ initial_image_path` | ✗ | Required for v3: an uploaded reference image path, or a completed image output owned by you. The caller supplies this image; the API does not generate it. | `"api-assets/id/reference.png".to_string()` |
| `└─ video_file_path` | ✗ | Your video file. Required if `video_source` is `file`. This value is either - a direct URL to the file. The URL path must end in a supported file extension. - `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.mp4".to_string()` |
| `└─ video_source` | ✓ | Choose your video source. | `V1VideoToVideoCreateBodyAssetsVideoSourceEnum::File` |
| `└─ youtube_url` | ✗ | YouTube URL (required if `video_source` is `youtube`). | `"http://www.example.com".to_string()` |
| `end_seconds` | ✓ | End time of your clip (seconds). Must be greater than start_seconds. | `5.0` |
| `start_seconds` | ✓ | Start time of your clip (seconds). Must be ≥ 0. | `0.0` |
| `style` | ✓ | | `V1VideoToVideoCreateBodyStyle {art_style: V1VideoToVideoCreateBodyStyleArtStyleEnum::Minecraft, model: Some(V1VideoToVideoCreateBodyStyleModelEnum::Default), prompt: Patch::new("A cinematic scene with warm lighting".to_string()), prompt_type: Some(V1VideoToVideoCreateBodyStylePromptTypeEnum::Default), version: Some(V1VideoToVideoCreateBodyStyleVersionEnum::Default)}` |
| `└─ art_style` | ✓ | | `V1VideoToVideoCreateBodyStyleArtStyleEnum::Minecraft` |
| `└─ model` | ✗ | * `Dreamshaper` - a good all-around model that works for both animations as well as realism. * `Absolute Reality` - better at realism, but you'll often get similar results with Dreamshaper as well. * `Flat 2D Anime` - best for a flat illustration style that's common in most anime. * `Default` - the v3 model. * `default` - use the default recommended model for the selected art style. | `V1VideoToVideoCreateBodyStyleModelEnum::Default` |
| `└─ prompt` | ✗ | The prompt used for the video. Prompt is required if `prompt_type` is `custom` or `append_default`. If `prompt_type` is `default`, then the `prompt` value passed will be ignored. | `"A cinematic scene with warm lighting".to_string()` |
| `└─ prompt_type` | ✗ | * `default` - Use the default recommended prompt for the art style. * `custom` - Only use the prompt passed in the API. Note: for v1, lora prompt will still be auto added to apply the art style properly. * `append_default` - Add the default recommended prompt to the end of the prompt passed in the API. | `V1VideoToVideoCreateBodyStylePromptTypeEnum::Default` |
| `└─ version` | ✗ | * `v1` - more detail, closer prompt adherence, and frame-by-frame previews. * `v2` - faster, more consistent, and less noisy. * `v3` - consistent styling guided by a caller-supplied reference image. Requires assets.initial_image_path and positive width/height. * `default` - use the selected art style's default version, including v3. | `V1VideoToVideoCreateBodyStyleVersionEnum::Default` |
| `fps` | ✗ | Source video FPS for v3 frame limits and estimated credits. Defaults to 30; final charges settle to rendered frames. | `30.0` |
| `fps_resolution` | ✗ | Determines whether the resulting video will have the same frame per second as the original video, or half. * `FULL` - the result video will have the same FPS as the input video * `HALF` - the result video will have half the FPS as the input video | `V1VideoToVideoCreateBodyFpsResolutionEnum::Half` |
| `height` | ✗ | Source video height in integer pixels. Required and positive for v3; ignored for v1/v2. | `704` |
| `name` | ✗ | Give your video a custom name for easy identification. | `"My Video To Video video".to_string()` |
| `width` | ✗ | Source video width in integer pixels. Required and positive for v3; ignored for v1/v2. | `1024` |
#### Example Snippet
```rust
let client = magic_hour::Client::default()
.with_bearer_auth(&std::env::var("API_TOKEN").unwrap());
let res = client
.v1()
.video_to_video()
.create(magic_hour::resources::v1::video_to_video::CreateRequest {
assets: magic_hour::models::V1VideoToVideoCreateBodyAssets {
video_file_path: Some("api-assets/id/1234.mp4".to_string()),
video_source: magic_hour::models::V1VideoToVideoCreateBodyAssetsVideoSourceEnum::File,
..Default::default()
},
end_seconds: 5.0,
fps: Some(30.0),
fps_resolution: Some(
magic_hour::models::V1VideoToVideoCreateBodyFpsResolutionEnum::Half,
),
height: magic_hour::Patch::new(704),
name: Some("My Video To Video video".to_string()),
start_seconds: 0.0,
style: magic_hour::models::V1VideoToVideoCreateBodyStyle {
art_style: magic_hour::models::V1VideoToVideoCreateBodyStyleArtStyleEnum::Minecraft,
model: Some(
magic_hour::models::V1VideoToVideoCreateBodyStyleModelEnum::Default,
),
prompt: magic_hour::Patch::new(
"A cinematic scene with warm lighting".to_string(),
),
prompt_type: Some(
magic_hour::models::V1VideoToVideoCreateBodyStylePromptTypeEnum::Default,
),
version: Some(
magic_hour::models::V1VideoToVideoCreateBodyStyleVersionEnum::Default,
),
},
width: magic_hour::Patch::new(1024),
})
.await;
```
#### Response
##### Type
[V1VideoToVideoCreateResponse](/src/models/v1_video_to_video_create_response.rs)
##### Example
```rust
V1VideoToVideoCreateResponse {credits_charged: 450, estimated_frame_cost: 123, id: "cuid-example".to_string()}
```