Create Video - Captions Help Center

Create Video

curl --request POST \
  --url https://api.mirage.app/v1/videos \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form 'audio_reference=<string>' \
  --form 'video_reference=<string>' \
  --form model=mirage-avatar-x

import requests

url = "https://api.mirage.app/v1/videos"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"audio_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\nmirage-avatar-x\r\n-----011000010111000001101001--"
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "multipart/form-data"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const form = new FormData();
form.append('audio_reference', '<string>');
form.append('video_reference', '<string>');
form.append('model', 'mirage-avatar-x');

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

options.body = form;

fetch('https://api.mirage.app/v1/videos', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mirage.app/v1/videos",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"audio_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\nmirage-avatar-x\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mirage.app/v1/videos"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"audio_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\nmirage-avatar-x\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mirage.app/v1/videos")
  .header("x-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"audio_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\nmirage-avatar-x\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirage.app/v1/videos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"audio_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\nmirage-avatar-x\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "completed_at": 1730822520,
  "created_at": 1730822400,
  "model": "mirage-avatar-x",
  "progress": 100,
  "status": "COMPLETE",
  "video_id": "video_abc123def456"
}

POST

/

v1

/

videos

Create Video

curl --request POST \
  --url https://api.mirage.app/v1/videos \
  --header 'Content-Type: multipart/form-data' \
  --header 'x-api-key: <api-key>' \
  --form 'audio_reference=<string>' \
  --form 'video_reference=<string>' \
  --form model=mirage-avatar-x

import requests

url = "https://api.mirage.app/v1/videos"

payload = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"audio_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\nmirage-avatar-x\r\n-----011000010111000001101001--"
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "multipart/form-data"
}

response = requests.post(url, data=payload, headers=headers)

print(response.text)

const form = new FormData();
form.append('audio_reference', '<string>');
form.append('video_reference', '<string>');
form.append('model', 'mirage-avatar-x');

const options = {method: 'POST', headers: {'x-api-key': '<api-key>'}};

options.body = form;

fetch('https://api.mirage.app/v1/videos', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.mirage.app/v1/videos",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"audio_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\nmirage-avatar-x\r\n-----011000010111000001101001--",
  CURLOPT_HTTPHEADER => [
    "Content-Type: multipart/form-data",
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.mirage.app/v1/videos"

	payload := strings.NewReader("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"audio_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\nmirage-avatar-x\r\n-----011000010111000001101001--")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.mirage.app/v1/videos")
  .header("x-api-key", "<api-key>")
  .body("-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"audio_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\nmirage-avatar-x\r\n-----011000010111000001101001--")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.mirage.app/v1/videos")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request.body = "-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"audio_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"video_reference\"\r\n\r\n<string>\r\n-----011000010111000001101001\r\nContent-Disposition: form-data; name=\"model\"\r\n\r\nmirage-avatar-x\r\n-----011000010111000001101001--"

response = http.request(request)
puts response.read_body

{
  "completed_at": 1730822520,
  "created_at": 1730822400,
  "model": "mirage-avatar-x",
  "progress": 100,
  "status": "COMPLETE",
  "video_id": "video_abc123def456"
}

Authorizations

x-api-key

string

header

required

API key for authentication.

Body

multipart/form-data

Video reference
Image reference

audio_reference

file

required

Driving audio file (WAV or MP3, 1-180 seconds)

video_reference

file | null

required

Video appearance reference (MP4 or MOV, 10-60 seconds; feature-gated preview). Exactly one visual reference is required.

model

enum<string>

default:mirage-avatar-x

Model to use for generation

Available options:

mirage-avatar-x,

mirage-video-1-latest

Response

200 - application/json

Returns a Video object representing the generation job

Represents a video object.

A video can be created via generation (an image or video appearance reference plus audio) or captioning (adding captions to an existing video).

id

string

required

Video generation job ID

Example:

"video_abc123def456"

status

enum<string>

required

Current state of the video

Available options:

PROCESSING,

COMPLETE,

FAILED,

CANCELLED

Example:

"COMPLETE"

created_at

integer

required

When the video was created (unix timestamp)

Example:

1730822400

video_id

string

required

deprecated

[Deprecated] Use "id" instead.

object

string

default:video

Allowed value: "video"

completed_at

integer | null

When processing completed (unix timestamp)

Example:

1730822520

progress

integer | null

Progress percentage (0-100)

Example:

100

error

MAVideoError · object | null

Error details if status is FAILED

Show child attributes

Example:

null

model

enum<string> | null

Model used for generation (only for source='generation')

Available options:

mirage-avatar-x,

mirage-video-1-latest

Example:

"mirage-avatar-x"

generation_mode

enum<string> | null

Generation mode resolved from the submitted inputs

Available options:

image_to_video,

video_to_video

Example:

"video_to_video"

aspect_ratio

enum<string> | null

Output aspect ratio resolved from the visual reference

Available options:

9:16,

16:9

Example:

"16:9"

source_video_id

string | null

The input video that was captioned (only for source='caption')

Example:

"video_abc123def456"

caption_template_id

string | null

Caption style template used (only for source='caption')

Example:

"ctpl_123456789abcdefg"

Last modified on October 16, 2026