Skip to main content
Glama

character_replace_create_video

What this API does

Create the same Character Replace 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 character replace into apps, pipelines, or tools

How it works (3 steps)

  1. Upload your inputs (video, image, or audio) with Generate Upload URLs and copy the file_path.

  2. Send a request to create a character replace 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.

MCP guidance:

  • This starts an async video generation job and returns id plus credits_charged immediately. If the user wants the finished result, call the wait_for_video_project helper with the returned id, or poll the matching GET /v1/video-projects/{id} endpoint until status is complete, error, or canceled. Completed projects include downloads with direct URLs. The custom wait helper also returns exact_download_urls separately from expiration metadata.

  • For *_file_path values, prefer an existing Magic Hour file path or a file_path returned by the upload-URL endpoint after the file bytes are uploaded. Direct public media URLs may work when they are stable, fetchable, and return raw file bytes, but hotlinked URLs can fail; when in doubt, use the presigned upload flow first and pass the returned file_path.

Input Schema

TableJSON Schema
NameRequiredDescriptionDefault
nameNoGive your video a custom name for easy identification.Character Replace - dateTime
styleNoOptional style controls for replace vs animate mode and subject selection.
assetsYesSource video and reference character image for the job.
resolutionNoOutput video resolution. Defaults to 480p, the lowest resolution available on your plan.
end_secondsYesEnd time of your clip (seconds). Must be greater than start_seconds.
start_secondsNoStart time of your clip (seconds). Must be ≥ 0.

Output Schema

TableJSON Schema
NameRequiredDescriptionDefault
idYesUnique 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_chargedYesThe 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.

Schema Changelog

Changes observed during successful MCP inspections. Dates show when Glama detected each change.

  1. First observed

TDQS

A4/5.0
Behavior5/5

Does the description disclose side effects, auth requirements, rate limits, or destructive behavior?

With no annotations, the description carries the full burden and does an excellent job. It explicitly discloses that the job is asynchronous, returns id and credits_charged immediately, requires polling, reports terminal statuses, and exposes downloads. It also warns about file path handling and hotlinked URL failures.

Agents need to know what a tool does to the world before calling it. Descriptions should go beyond structured annotations to explain consequences.

Conciseness4/5

Is the description appropriately sized, front-loaded, and free of redundancy?

The description is long but well-structured with clear sections and front-loaded purpose. The MCP guidance is valuable and earns its place, though some redundancy exists between 'How it works' and the schema/API workflow.

Shorter descriptions cost fewer tokens and are easier for agents to parse. Every sentence should earn its place.

Completeness5/5

Given the tool's complexity, does the description cover enough for an agent to succeed on first attempt?

For a complex async tool with nested parameters and no annotations, the description is remarkably complete. It covers the full lifecycle from upload and job creation through polling to downloading results, plus cost, resolution limits, and file path gotchas. An output schema presumably covers return-value details.

Complex tools with many parameters or behaviors need more documentation. Simple tools need less. This dimension scales expectations accordingly.

Parameters3/5

Does the description clarify parameter syntax, constraints, interactions, or defaults beyond what the schema provides?

Schema description coverage is 100%, so the baseline is 3 and the schema already documents every parameter. The description adds useful high-level context around resolution limits, file inputs, and costs, but it does not deeply elaborate on individual parameter semantics beyond the schema.

Input schemas describe structure but not intent. Descriptions should explain non-obvious parameter relationships and valid value ranges.

Purpose4/5

Does the description clearly state what the tool does and how it differs from similar tools?

The description states a clear verb and resource: programmatically create a Character Replace video job. It is easy to understand what the tool does, but it does not differentiate itself from sibling tools like face_swap_create_video or video_to_video_create_video.

Agents choose between tools based on descriptions. A clear purpose with a specific verb and resource helps agents select the right tool.

Usage Guidelines3/5

Does the description explain when to use this tool, when not to, or what alternatives exist?

The 'Good for' section gives broad usage context such as automation, batch processing, and app integration. However, it does not mention alternative tools or when not to use this tool, leaving sibling selection mostly to the agent's inference.

Agents often have multiple tools that could apply. Explicit usage guidance like "use X instead of Y when Z" prevents misuse.

Try in Browser

Glama MCP Gateway

Add one secure layer between your agents and this server.

TDQS

A3.6/5.0
Disambiguation3/5

Most generation tools target distinct media types or effects (e.g., clothes changer, head swap, lip sync), but several boundaries blur: ai_image_editor_create_image is a generic edit tool that overlaps conceptually with ai_face_editor_edit_image, ai_image_upscaler_create_image, and background remover. The wait_for_*_project helpers also overlap functionally with the *_projects_retrieve_details status tools, and ai_voice_cloner_create_audio vs. ai_voice_generator_create_audio are easy to confuse by name.

Naming Consistency2/5

Naming conventions are mixed: many tools follow ai_<product>_create_<media>, but others are product-first (animation_create_video, body_swap_create_image) and resource-group tools follow a different noun_verb pattern (audio_projects_retrieve_details, video_projects_delete). Verbs are inconsistent too (create_image, edit_image, detect_faces, retrieve_details, wait_for, fetch), so an agent cannot reliably predict the next tool name.

Tool Count2/5

At 44 tools, the set is heavy: it includes 27 generation tools plus three wait helpers, three status retrieval tools, three delete tools, three fetch helpers, and upload/ping utilities. While the underlying product is broad, many helpers could be consolidated, and the overall surface exceeds the range where each tool earns a clear place.

Completeness3/5

The lifecycle is mostly covered for image, video, and audio projects: create, poll/retrieve, fetch download, delete, and file upload/presigned-URL generation are all present. However, there is no project listing or cancel operation, and face detection only has detect/details with no delete or wait helper, leaving some workflow gaps an agent must work around.