> ## Documentation Index > Fetch the complete documentation index at: https://docs.magichour.ai/llms.txt > Use this file to discover all available pages before exploring further. # AI Video Editor > **What this API does** Create the same Video Editor 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 editor 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 editor 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: free users are limited to 576px; higher plans unlock HD and larger sizes - Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt **Cost** Credits are only charged for the frames that actually render. You'll see an estimate when the job is queued, and the final total after it's done. For detailed examples, see the [product page](https://magichour.ai/products/ai-video-editor). ## OpenAPI ````yaml /api-reference/openapi.json post /v1/ai-video-editor openapi: 3.0.2 info: title: Magic Hour API version: beta description: > Magic Hour provides an API (beta) that can be integrated into your own application to generate videos and images using AI. Webhook documentation can be found [here](https://docs.magichour.ai/webhook-reference). If you have any questions, please reach out to us via [discord](https://discord.gg/JX5rgsZaJp). # Authentication Every request requires an API key. To get started, first generate your API key [here](https://magichour.ai/developer?tab=api-keys&utm_source=docs&utm_medium=referral&utm_campaign=api-reference). Then, add the `Authorization` header to the request. | Key | Value | |-|-| | Authorization | Bearer mhk_live_apikey | > **Warning**: any API call that renders a video will utilize credits in your account. termsOfService: https://magichour.ai/terms-of-service servers: - url: https://api.magichour.ai security: [] tags: - name: Files description: API related to uploading and reusing assets - name: Image Projects description: API related to image projects - name: Video Projects description: API related to video projects - name: Audio Projects description: API related to audio projects - name: Account description: API related to the account that owns the API key paths: /v1/ai-video-editor: post: tags: - Video Projects summary: AI Video Editor description: >- **What this API does** Create the same Video Editor 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 editor 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 editor 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: free users are limited to 576px; higher plans unlock HD and larger sizes - Extra fields: e.g. `face_swap_mode`, `start_seconds`/`end_seconds`, or a text prompt **Cost** Credits are only charged for the frames that actually render. You'll see an estimate when the job is queued, and the final total after it's done. For detailed examples, see the [product page](https://magichour.ai/products/ai-video-editor). operationId: aiVideoEditor.createVideo parameters: [] requestBody: required: true description: Body content: application/json: schema: type: object properties: name: type: string description: Give your video a custom name for easy identification. example: My Video Editor video default: Video Editor - dateTime start_seconds: default: 0 type: number minimum: 0 description: Start time of your clip (seconds). Must be ≥ 0. format: float example: 0 end_seconds: type: number minimum: 0.1 description: >- End time of your clip in seconds. Must be greater than `start_seconds`. Minimum duration depends on model: `gemini-omni-1.1`: 3s, `ltx-2.3`: 0.5s. Maximum duration depends on model: `gemini-omni-1.1`: 10s, `ltx-2.3`: 45s. format: float example: 5 model: type: string enum: - gemini-omni-1.1 - gemini-omni - ltx-2.3 description: >- Editing model. Defaults to `ltx-2.3` for free tier and `gemini-omni-1.1` for paid. `gemini-omni` is deprecated; use `gemini-omni-1.1` instead. example: gemini-omni-1.1 resolution: type: string enum: - 480p - 720p - 1080p description: >- Output resolution. Defaults to `480p` for free tier and `720p` for paid. `gemini-omni-1.1` and deprecated `gemini-omni` support 720p and 1080p; LTX-2.3 supports 480p, 720p, and 1080p. example: 720p style: type: object properties: prompt: type: string minLength: 1 description: The prompt used to edit the video. example: Change the car color to blue required: - prompt assets: type: object properties: video_file_path: type: string minLength: 1 description: > The video to edit. 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. example: api-assets/id/1234.mp4 required: - video_file_path description: Provide the assets for video editing. required: - end_seconds - style - assets responses: '200': description: Success content: application/json: schema: type: object properties: id: type: string example: cuid-example description: >- Unique ID of the video. Use it with the [Get video Project API](https://docs.magichour.ai/api-reference/video-projects/get-video-details) to fetch status and downloads. credits_charged: type: integer description: >- 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. example: 450 required: - id - credits_charged description: Success '400': description: Invalid Request content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - invalid_request description: >- Machine-readable error code. - `invalid_request`: Fix request syntax or validation errors before retrying. message: type: string description: Human-readable error message. '401': description: Unauthorized content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - unauthorized description: |- Machine-readable error code. - `unauthorized`: Provide a valid API key before retrying. message: type: string description: Human-readable error message. '402': description: Payment Required content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - insufficient_credits - subscription_required - plan_upgrade_required description: >- Machine-readable error code. - `insufficient_credits`: Purchase credits before retrying. - `subscription_required`: Start a subscription before retrying. - `plan_upgrade_required`: Upgrade the subscription plan before retrying. message: type: string description: Human-readable error message. '404': description: Not Found content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - not_found description: |- Machine-readable error code. - `not_found`: Check the route or resource identifier. message: type: string description: Human-readable error message. '422': description: Unprocessable Entity content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - unprocessable_entity description: >- Machine-readable error code. - `unprocessable_entity`: Change the request values before retrying. message: type: string description: Human-readable error message. '500': description: Internal Server Error content: application/json: schema: type: object required: - code - message properties: code: type: string enum: - internal_server_error description: >- Machine-readable error code. - `internal_server_error`: Retry later or contact support if the error continues. message: type: string description: Human-readable error message. security: - bearerAuth: [] x-codeSamples: - lang: python source: |- from magic_hour import Client from os import getenv client = Client(token=getenv("API_TOKEN")) res = client.v1.ai_video_editor.generate( assets={"video_file_path": "/path/to/1234.mp4"}, end_seconds=5.0, style={"prompt": "Change the car color to blue"}, name="My Video Editor video", start_seconds=0.0, wait_for_completion=True, download_outputs=True, download_directory=".", ) - lang: javascript source: |- import { Client } from "magic-hour"; const client = new Client({ token: process.env["API_TOKEN"]!! }); const res = await client.v1.aiVideoEditor.generate( { assets: { videoFilePath: "/path/to/1234.mp4" }, endSeconds: 5.0, name: "My Video Editor video", startSeconds: 0.0, style: { prompt: "Change the car color to blue" }, }, { waitForCompletion: true, downloadOutputs: true, downloadDirectory: ".", }, ); - lang: go source: "package main\n\nimport (\n\tos \"os\"\n\n\tsdk \"github.com/magichourhq/magic-hour-go/client\"\n\tnullable \"github.com/magichourhq/magic-hour-go/nullable\"\n\tai_video_editor \"github.com/magichourhq/magic-hour-go/resources/v1/ai_video_editor\"\n\ttypes \"github.com/magichourhq/magic-hour-go/types\"\n)\n\nfunc main() {\n\tclient := sdk.NewClient(\n\t\tsdk.WithBearerAuth(os.Getenv(\"API_TOKEN\")),\n\t)\n\tres, err := client.V1.AiVideoEditor.Create(ai_video_editor.CreateRequest{\n\t\tAssets: types.V1AiVideoEditorCreateBodyAssets{\n\t\t\tVideoFilePath: \"api-assets/id/1234.mp4\",\n\t\t},\n\t\tEndSeconds: 5.0,\n\t\tModel: nullable.NewValue(types.V1AiVideoEditorCreateBodyModelEnumGeminiOmni11),\n\t\tName: nullable.NewValue(\"My Video Editor video\"),\n\t\tResolution: nullable.NewValue(types.V1AiVideoEditorCreateBodyResolutionEnum720p),\n\t\tStartSeconds: nullable.NewValue(0.0),\n\t\tStyle: types.V1AiVideoEditorCreateBodyStyle{\n\t\t\tPrompt: \"Change the car color to blue\",\n\t\t},\n\t})\n}" - lang: rust source: |- let client = magic_hour::Client::default() .with_bearer_auth(&std::env::var("API_TOKEN").unwrap()); let res = client .v1() .ai_video_editor() .create(magic_hour::resources::v1::ai_video_editor::CreateRequest { assets: magic_hour::models::V1AiVideoEditorCreateBodyAssets { video_file_path: "api-assets/id/1234.mp4".to_string(), }, end_seconds: 5.0, model: Some( magic_hour::models::V1AiVideoEditorCreateBodyModelEnum::GeminiOmni11, ), name: Some("My Video Editor video".to_string()), resolution: Some( magic_hour::models::V1AiVideoEditorCreateBodyResolutionEnum::Enum720p, ), start_seconds: Some(0.0), style: magic_hour::models::V1AiVideoEditorCreateBodyStyle { prompt: "Change the car color to blue".to_string(), }, }) .await; - lang: curl source: |- curl --request POST \ --url https://api.magichour.ai/v1/ai-video-editor \ --header 'accept: application/json' \ --header 'authorization: Bearer ' \ --header 'content-type: application/json' \ --data ' { "name": "My Video Editor video", "start_seconds": 0, "end_seconds": 5, "model": "gemini-omni-1.1", "resolution": "720p", "style": { "prompt": "Change the car color to blue" }, "assets": { "video_file_path": "api-assets/id/1234.mp4" } } ' - lang: php source: |- "https://api.magichour.ai/v1/ai-video-editor", CURLOPT_RETURNTRANSFER => true, CURLOPT_ENCODING => "", CURLOPT_MAXREDIRS => 10, CURLOPT_TIMEOUT => 30, CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1, CURLOPT_CUSTOMREQUEST => "POST", CURLOPT_POSTFIELDS => json_encode([ 'name' => 'My Video Editor video', 'start_seconds' => 0, 'end_seconds' => 5, 'model' => 'gemini-omni-1.1', 'resolution' => '720p', 'style' => [ 'prompt' => 'Change the car color to blue' ], 'assets' => [ 'video_file_path' => 'api-assets/id/1234.mp4' ] ]), CURLOPT_HTTPHEADER => [ "accept: application/json", "authorization: Bearer ", "content-type: application/json" ], ]); $response = curl_exec($curl); $err = curl_error($curl); curl_close($curl); if ($err) { echo "cURL Error #:" . $err; } else { echo $response; } - lang: java source: >- HttpResponse response = Unirest.post("https://api.magichour.ai/v1/ai-video-editor") .header("accept", "application/json") .header("content-type", "application/json") .header("authorization", "Bearer ") .body("{\"name\":\"My Video Editor video\",\"start_seconds\":0,\"end_seconds\":5,\"model\":\"gemini-omni-1.1\",\"resolution\":\"720p\",\"style\":{\"prompt\":\"Change the car color to blue\"},\"assets\":{\"video_file_path\":\"api-assets/id/1234.mp4\"}}") .asString(); components: securitySchemes: bearerAuth: type: http scheme: bearer description: >- Bearer authentication header of the form `Bearer `, where `` is your API key. To get your API key, go to [Developer Hub](https://magichour.ai/developer?tab=api-keys&utm_source=docs&utm_medium=referral&utm_campaign=api-reference) and click "Create new API Key". ````